OnLockerSwap

OxideCarbonStructure

Called when a locker swaps.

object OnLockerSwap(Locker locker, int local0, BasePlayer player)

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

Parameters

locker: Locker
local0: int
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 OnLockerSwap(Locker locker, int local0, BasePlayer player)
{
    Puts("OnLockerSwap");

    // 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 Locker.RPC_Equip(BaseEntity.RPCMessage)

Passes: Locker locker, int local0, BasePlayer player

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

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

// …
[RPC_Server.IsVisible(3f)]
public void RPC_Equip(RPCMessage msg)
{
	int num = msg.read.Int32();
	if (num < 0 || num >= maxGearSets || IsEquipping())
	{
		return;
	}
	if (Interface.CallHook("OnLockerSwap", this, num, msg.player) != null)
	{
		return;
	}
	BasePlayer player = msg.player;
	if (player.IsDead() || !CanBeLooted(player))
	{
		return;
	}
// …

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.