OnQuarryToggle

OxideResource

object OnQuarryToggle(MiningQuarry miningQuarry, BasePlayer player)

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

Parameters

miningQuarry: MiningQuarry
player: BasePlayer

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 OnQuarryToggle(MiningQuarry miningQuarry, BasePlayer player)
{
    Puts("OnQuarryToggle");

    // 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 EngineSwitch.StartEngine(BaseEntity.RPCMessage)

Passes: MiningQuarry miningQuarry, BasePlayer player

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

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
public void StartEngine(RPCMessage msg)
{
	MiningQuarry miningQuarry = GetParentEntity() as MiningQuarry;
	if ((bool)miningQuarry)
	{
		if (Interface.CallHook("OnQuarryToggle", miningQuarry, msg.player) != null)
		{
			return;
		}
		miningQuarry.EngineSwitch(isOn: true);
	}
}

Injection point 2

Rust.opj (Oxide)

void EngineSwitch.StopEngine(BaseEntity.RPCMessage)

Passes: MiningQuarry miningQuarry, BasePlayer player

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

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
public void StopEngine(RPCMessage msg)
{
	MiningQuarry miningQuarry = GetParentEntity() as MiningQuarry;
	if ((bool)miningQuarry)
	{
		if (Interface.CallHook("OnQuarryToggle", miningQuarry, msg.player) != null)
		{
			return;
		}
		miningQuarry.EngineSwitch(isOn: false);
	}
}

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.