OnExcavatorSuppliesRequest

OxideCarbonElectronic

Called when excavator supplies request occurs.

object OnExcavatorSuppliesRequest(ExcavatorSignalComputer excavatorSignalComputer, BasePlayer player)

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

Parameters

excavatorSignalComputer: ExcavatorSignalComputer
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 OnExcavatorSuppliesRequest(ExcavatorSignalComputer excavatorSignalComputer, BasePlayer player)
{
    Puts("OnExcavatorSuppliesRequest");

    // 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 ExcavatorSignalComputer.RequestSupplies(BaseEntity.RPCMessage)

Passes: ExcavatorSignalComputer excavatorSignalComputer, BasePlayer player

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

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

[RPC_Server]
[RPC_Server.IsVisible(3f)]
[RPC_Server.CallsPerSecond(5uL)]
public void RequestSupplies(RPCMessage rpc)
{
	if (HasFlag(Flags.Reserved7) && IsPowered() && chargePower >= GetChargeNeededForSupplies() && HasSuppliesRemaining())
	{
		if (Interface.CallHook("OnExcavatorSuppliesRequest", this, rpc.player) != null)
		{
			return;
		}
		BaseEntity baseEntity = GameManager.server.CreateEntity(supplyPlanePrefab.resourcePath);
		if ((bool)baseEntity)
		{
			Vector3 position = dropPoints[Random.Range(0, dropPoints.Length)].position;
			Vector3 vector = new Vector3(Random.Range(-3f, 3f), 0f, Random.Range(-3f, 3f));
// …

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.