OnTurretModeToggle

OxideTurret

object OnTurretModeToggle(AutoTurret autoTurret, BasePlayer player)

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

Parameters

autoTurret: AutoTurret
player: BasePlayer

Return value

objectReturn a value of the method's result type and the game returns it immediately; null continues as usual.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnTurretModeToggle(AutoTurret autoTurret, BasePlayer player)
{
    Puts("OnTurretModeToggle");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return null; // null — the game continues as usual
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point 1

Rust.opj (Oxide)

void AutoTurret.SERVER_Peacekeeper(BaseEntity.RPCMessage)

Passes: AutoTurret autoTurret, 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)]
private void SERVER_Peacekeeper(RPCMessage rpc)
{
	if (IsAuthed(rpc.player))
	{
		if (Interface.CallHook("OnTurretModeToggle", this, rpc.player) != null)
		{
			return;
		}
		SetPeacekeepermode(isOn: true);
	}
}

Injection point 2

Rust.opj (Oxide)

void AutoTurret.SERVER_AttackAll(BaseEntity.RPCMessage)

Passes: AutoTurret autoTurret, 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)]
private void SERVER_AttackAll(RPCMessage rpc)
{
	if (IsAuthed(rpc.player))
	{
		if (Interface.CallHook("OnTurretModeToggle", this, rpc.player) != null)
		{
			return;
		}
		SetPeacekeepermode(isOn: false);
	}
}

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.