OnItemRemove

OxideCarbonItem

Called when an item is removed.

object OnItemRemove(Item item)

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

Parameters

item: Item

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 OnItemRemove(Item item)
{
    Puts("OnItemRemove");

    // 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 Item.Remove(float)

Passes: Item item

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public void Remove(float fTime = 0f)
{
	if (removeTime > 0f)
	{
		return;
	}
	if (Interface.CallHook("OnItemRemove", this) != null)
	{
		return;
	}
	if (isServer)
	{
		ItemMod[] itemMods = info.itemMods;
		for (int i = 0; i < itemMods.Length; i++)
		{
// …

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.