OnPlayerColliderEnable

OxideCarbonPlayer

Called when player collider enable occurs.

object OnPlayerColliderEnable(BasePlayer basePlayer, CapsuleCollider playerCollider)

Method changed — check — the game method differs from the one the hook is recorded for in Oxide. The hook is still called, but its place may have shifted — worth checking after an update.

Parameters

basePlayer: BasePlayer
playerCollider: CapsuleCollider

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 OnPlayerColliderEnable(BasePlayer basePlayer, CapsuleCollider playerCollider)
{
    Puts("OnPlayerColliderEnable");

    // 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.EnablePlayerCollider()

Passes: BasePlayer basePlayer, CapsuleCollider playerCollider

Method changed — checkReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, this.playerCollider)Assembly-CSharp.dll

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

public void EnablePlayerCollider()
{
	if (!playerCollider.enabled && !(isServer & isInvisible))
	{
		if (Interface.CallHook("OnPlayerColliderEnable", this, this.playerCollider) != null)
		{
			return;
		}
		RefreshColliderSize(forced: true);
		playerCollider.enabled = true;
	}
}

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.