RustTip

OnTrapSnapped

OxideCarbonTraps

Called when a trap is snapped.

void OnTrapSnapped(BaseTrapTrigger baseTrapTrigger, GameObject obj, Collider col)
Works — the game method in this build is the one the hook was written for.

Parameters

baseTrapTrigger
BaseTrapTrigger
obj
GameObject
col
Collider

Return value

voidThe return value is ignored — the hook only notifies.

Example

private void OnTrapSnapped(BaseTrapTrigger baseTrapTrigger, GameObject obj, Collider col)
{
    Puts("OnTrapSnapped");
}

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

Injection point

Rust.opj (Oxide)
void BaseTrapTrigger.OnObjectAdded(GameObject, Collider)

Passes: BaseTrapTrigger baseTrapTrigger, GameObject obj, Collider col

WorksReturnBehavior: ContinueArgumentBehavior: AllAssembly-CSharp.dll

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

internal override void OnObjectAdded(GameObject obj, Collider col)
{
	Interface.CallHook("OnTrapSnapped", this, obj, col);
	base.OnObjectAdded(obj, col);
	_trap.ObjectEntered(obj);
}

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.