OnSiegeWeaponPull

OxideCarbonPrimitive

Called when siege weapon pull occurs.

object OnSiegeWeaponPull(BaseSiegeWeapon baseSiegeWeapon, BasePlayer player)

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

Parameters

baseSiegeWeapon: BaseSiegeWeapon
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 OnSiegeWeaponPull(BaseSiegeWeapon baseSiegeWeapon, BasePlayer player)
{
    Puts("OnSiegeWeaponPull");

    // 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 BaseSiegeWeapon.SERVER_StartPulling(BaseEntity.RPCMessage)

Passes: BaseSiegeWeapon baseSiegeWeapon, 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)]
public void SERVER_StartPulling(RPCMessage msg)
{
	BasePlayer player = msg.player;
	if (CanPullNow(player) && !(rigidBody == null) && (!OnlyOwnerAccessible() || !(player != creatorEntity)))
	{
		if (Interface.CallHook("OnSiegeWeaponPull", this, msg.player) != null)
		{
			return;
		}
		player.metabolism.calories.Subtract(3f);
		player.metabolism.SendChanges();
		if (rigidBody.IsSleeping())
		{
			rigidBody.WakeUp();
// …

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.