OnExcavatorResourceSet

OxideCarbonResource

Called when excavator resource set occurs.

object OnExcavatorResourceSet(ExcavatorArm excavatorArm, string local0, BasePlayer player)

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

Parameters

excavatorArm: ExcavatorArm
local0: string
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 OnExcavatorResourceSet(ExcavatorArm excavatorArm, string local0, BasePlayer player)
{
    Puts("OnExcavatorResourceSet");

    // 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 ExcavatorArm.RPC_SetResourceTarget(BaseEntity.RPCMessage)

Passes: ExcavatorArm excavatorArm, string local0, BasePlayer player

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

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
public void RPC_SetResourceTarget(RPCMessage msg)
{
	switch (msg.read.String())
	{
	case "HQM":
		if (Interface.CallHook("OnExcavatorResourceSet", this, local0, msg.player) != null)
		{
			return;
		}
		resourceMiningIndex = 0;
		break;
	case "Sulfur":
		resourceMiningIndex = 1;
		break;
// …

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.