OnItemAction

OxideCarbonItem

Called when item action occurs.

object OnItemAction(Item local2, string local1, 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

local2: Item
local1: string
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 OnItemAction(Item local2, string local1, BasePlayer player)
{
    Puts("OnItemAction");

    // 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 PlayerInventory.ItemCmd(BaseEntity.RPCMessage)

Passes: Item local2, string local1, BasePlayer player

Method changed — checkReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (l2, l1, a0.player)Assembly-CSharp.dll

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

// …
}
ItemId id = msg.read.ItemID();
string text = msg.read.String();
Item item = FindItemByUID(id);
if (item == null)
{
	return;
}
if (Interface.CallHook("OnItemAction", item, text, msg.player) != null)
{
	return;
}
BaseEntity entityOwner = item.GetEntityOwner();
if ((entityOwner != null && entityOwner == msg.player && msg.player.IsRestrainedOrSurrendering) || item.IsLocked() || (item.parent != null && item.parent.IsLocked()) || !CanMoveItemsFrom(item.GetEntityOwner(), item).allowed)
{
	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.