OnSiegeWeaponDoorOpen

OxidePrimitive

object OnSiegeWeaponDoorOpen(BatteringRam batteringRam, BasePlayer player)

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

Parameters

batteringRam: BatteringRam
player: BasePlayer

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 OnSiegeWeaponDoorOpen(BatteringRam batteringRam, BasePlayer player)
{
    Puts("OnSiegeWeaponDoorOpen");

    // 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 BatteringRam.RPC_OpenDoor(BaseEntity.RPCMessage)

Passes: BatteringRam batteringRam, BasePlayer player

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

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
[RPC_Server.CallsPerSecond(2uL)]
protected void RPC_OpenDoor(RPCMessage rpc)
{
	if (rpc.player.CanInteract(usableWhileCrawling: true) && CanOpenDoor())
	{
		if (Interface.CallHook("OnSiegeWeaponDoorOpen", this, rpc.player) != null)
		{
			return;
		}
		OpenDoor();
	}
}

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.