OnPlayerTick

OxideCarbonPlayer

Called when player tick occurs.

object OnPlayerTick(BasePlayer basePlayer, PlayerTick msg, bool wasPlayerStalled)

Works — the game method in this build is the one the hook was written for.

Parameters

basePlayer: BasePlayer
msg: PlayerTick
wasPlayerStalled: bool

Return value

objectReturn non-null to cancel the game action.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnPlayerTick(BasePlayer basePlayer, PlayerTick msg, bool wasPlayerStalled)
{
    Puts("OnPlayerTick");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // non-null cancels the game action
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)

void BasePlayer.OnReceiveTick(PlayerTick, bool)

Passes: BasePlayer basePlayer, PlayerTick msg, bool wasPlayerStalled

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

Where it is called (this branch's game code)

private void OnReceiveTick(PlayerTick msg, bool wasPlayerStalled)
{
	if (msg.inputState != null)
	{
		serverInput.Flip(msg.inputState);
	}
	if (Interface.CallHook("OnPlayerTick", this, msg, wasPlayerStalled) != null)
	{
		return;
	}
	if (serverInput.current.buttons != serverInput.previous.buttons)
	{
		ResetInputIdleTime();
	}
	if (IsReceivingSnapshot || IsTransferProtected())
// …

Sources: Rust.opj from OxideMod/Oxide.Rust (MIT) and hook metadata of the Carbon documentation (MIT). Method code is decompiled from this branch's server.