RustTip

OnTrapDisarm

OxideCarbonTraps

Called when trap disarm occurs.

object OnTrapDisarm(Landmine landmine, BasePlayer player)
Works — the game method in this build is the one the hook was written for.

Parameters

landmine
Landmine
player
BasePlayer

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 OnTrapDisarm(Landmine landmine, BasePlayer player)
{
    Puts("OnTrapDisarm");

    // 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 Landmine.RPC_Disarm(BaseEntity.RPCMessage)

Passes: Landmine landmine, BasePlayer player

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, a0.player)Assembly-CSharp.dll

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
private void RPC_Disarm(RPCMessage rpc)
{
	if ((ulong)rpc.player.userID == triggerPlayerID || !Armed() || !Triggered())
	{
		return;
	}
	if (Interface.CallHook("OnTrapDisarm", this, rpc.player) != null)
	{
		return;
	}
	if (Random.Range(0, 100) < 15)
	{
		Invoke(TryExplode, 0.05f);
		return;
	}
// …

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.