OnCoalingTowerStart

OxideCarbonResource

Called when a coaling tower starts.

object OnCoalingTowerStart(CoalingTower coalingTower, BasePlayer player)

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

Parameters

coalingTower: CoalingTower
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 OnCoalingTowerStart(CoalingTower coalingTower, BasePlayer player)
{
    Puts("OnCoalingTowerStart");

    // 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 CoalingTower.RPC_Unload(BaseEntity.RPCMessage)

Passes: CoalingTower coalingTower, BasePlayer player

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

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
private void RPC_Unload(RPCMessage msg)
{
	if (Interface.CallHook("OnCoalingTowerStart", this, msg.player) != null)
	{
		return;
	}
	if (!TryUnloadActiveWagon(out var attemptStatus) && msg.player != null)
	{
		ClientRPC(RpcTarget.Player("ActionFailed", msg.player), (byte)attemptStatus, arg2: 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.