OnActiveItemChange

OxideCarbonPlayer

Called when an active item is changed.

object OnActiveItemChange(BasePlayer basePlayer, Item local1, ItemId itemID)

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

Parameters

basePlayer: BasePlayer
local1: Item
itemID: ItemId

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 OnActiveItemChange(BasePlayer basePlayer, Item local1, ItemId itemID)
{
    Puts("OnActiveItemChange");

    // 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 BasePlayer.UpdateActiveItem(ItemId)

Passes: BasePlayer basePlayer, Item local1, ItemId itemID

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

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

// …
	itemID = default;
}
Item item = inventory.containerBelt.FindItemByUID(itemID);
if (IsItemHoldRestricted(item))
{
	itemID = default;
}
Item activeItem = GetActiveItem();
if (Interface.CallHook("OnActiveItemChange", this, activeItem, itemID) != null)
{
	return;
}
svActiveItemID = default;
if (activeItem != null)
{
	HeldEntity heldEntity = activeItem.GetHeldEntity() as HeldEntity;
	if (heldEntity != null)
// …

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.