CanEquipItem

OxideCarbonItem

Called to determine whether to equip item.

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

object CanEquipItem(PlayerInventory playerInventory, Item item, int targetSlot, BasePlayer player)

Method changed — check — the game method differs from the one the hook is recorded for in Oxide. The hook is still called, but its place may have shifted — worth checking after an update.

Parameters

playerInventory: PlayerInventory
item: Item
targetSlot: int
player: BasePlayer

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

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

private object CanEquipItem(PlayerInventory playerInventory, Item item, int targetSlot, BasePlayer player)
{
    Puts("CanEquipItem");

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

    // to affect the game:
    // return false; // your value instead of the game result
}

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

Injection point

Rust.opj (Oxide)

bool PlayerInventory.CanEquipItem(BasePlayer, Item, int)

Passes: PlayerInventory playerInventory, Item item, int targetSlot, BasePlayer player

Method changed — checkReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, a1, a2, a0)Assembly-CSharp.dll

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

private bool CanEquipItem(BasePlayer player, Item item, int targetSlot)
{
	object returnvar = Interface.CallHook("CanEquipItem", this, item, targetSlot, player);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if ((item.info.flags & ItemDefinition.Flag.NotAllowedInBelt) != 0)
	{
		return 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.