RustTip

OnQuarryToggled

OxideResource
object OnQuarryToggled()
object OnQuarryToggled(MiningQuarry miningQuarry, BasePlayer player)
Works — the game method in this build is the one the hook was written for.

Parameters

No parameters.

Return value

objectReturn non-null to stop the game method.

Example

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

private object OnQuarryToggled()
{
    Puts("OnQuarryToggled");

    // 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 1

Rust.opj (Oxide)
void EngineSwitch.StopEngine(BaseEntity.RPCMessage)

Passes: —

WorksReturnBehavior: ExitWhenNonNullAssembly-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 (Interface.CallHook("OnQuarryToggled") != null)
	{
		return;
	}
	if ((bool)miningQuarry)
	{
		miningQuarry.EngineSwitch(isOn: false);
	}
}

Injection point 2

Rust.opj (Oxide)
void EngineSwitch.StopEngine(BaseEntity.RPCMessage)

Passes: MiningQuarry miningQuarry, BasePlayer player

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

Injection point 3

Rust.opj (Oxide)
void EngineSwitch.StartEngine(BaseEntity.RPCMessage)

Passes: MiningQuarry miningQuarry, BasePlayer player

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

Injection point 4

Rust.opj (Oxide)
void EngineSwitch.StartEngine(BaseEntity.RPCMessage)

Passes: —

WorksReturnBehavior: ExitWhenNonNullAssembly-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 (Interface.CallHook("OnQuarryToggled") != null)
	{
		return;
	}
	if ((bool)miningQuarry)
	{
		miningQuarry.EngineSwitch(isOn: 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.