OnTrapTrigger

OxideTraps

object OnTrapTrigger(BearTrap bearTrap, GameObject obj)
object OnTrapTrigger(Landmine landmine, GameObject obj)

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

Parameters

bearTrap: BearTrap
obj: GameObject

Return value

objectReturn a value of the method's result type and the game returns it immediately; null continues as usual.

Example

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

private object OnTrapTrigger(BearTrap bearTrap, GameObject obj)
{
    Puts("OnTrapTrigger");

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

    // to affect the game:
    // return null; // null — the game continues as usual
}

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

Injection point 1

Rust.opj (Oxide)

void BearTrap.ObjectEntered(GameObject)

Passes: BearTrap bearTrap, GameObject obj

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

public override void ObjectEntered(GameObject obj)
{
	if (Armed())
	{
		if (Interface.CallHook("OnTrapTrigger", this, obj) != null)
		{
			return;
		}
		hurtTarget = obj;
		Invoke(DelayedFire, 0.05f);
	}
}

Injection point 2

Rust.opj (Oxide)

void Landmine.ObjectEntered(GameObject)

Passes: Landmine landmine, GameObject obj

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

// …
	{
		if (!Armed())
		{
			CancelInvoke(Arm);
			blocked = true;
		}
		else
		{
			if (Interface.CallHook("OnTrapTrigger", this, obj) != null)
			{
				return;
			}
			BasePlayer ply = obj.ToBaseEntity() as BasePlayer;
			Trigger(ply);
		}
	}
}

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.