RustTip

CanMannequinSwap

OxideCarbonEntity

Called to determine whether to mannequin swap.

Return true to allow the action and false to block it.

object CanMannequinSwap(Mannequin mannequin, BasePlayer local0)
Works — the game method in this build is the one the hook was written for.

Parameters

mannequin
Mannequin
local0
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 CanMannequinSwap(Mannequin mannequin, BasePlayer local0)
{
    Puts("CanMannequinSwap");

    // 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 Mannequin.Server_RequestSwap(BaseEntity.RPCMessage)

Passes: Mannequin mannequin, BasePlayer local0

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

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

// …
{
	return;
}
BasePlayer player = msg.player;
if (!CanBeLooted(player) || player.IsDead())
{
	return;
}
if (Interface.CallHook("CanMannequinSwap", this, player) != null)
{
	return;
}
BaseLock baseLock = GetLock();
if (baseLock != null && !baseLock.OnTryToOpen(player))
{
	player.ShowToast(GameTip.Styles.Error, PlayerInventoryErrors.ContainerLocked, 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.