OnInventoryItemsFind

OxideCarbonItem

Called when an inventory items is found.

object OnInventoryItemsFind(PlayerInventory playerInventory, int id, List<Item> list)

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

Parameters

playerInventory: PlayerInventory
id: int
list: List<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 OnInventoryItemsFind(PlayerInventory playerInventory, int id, List<Item> list)
{
    Puts("OnInventoryItemsFind");

    // 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.FindItemsByItemID(List<Item>, int)

Passes: PlayerInventory playerInventory, int id, List<Item> list

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

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

[PoolAnalyzerNonCaching]
public void FindItemsByItemID(List<Item> list, int id)
{
	if (Interface.CallHook("OnInventoryItemsFind", this, id, list) != null)
	{
		return;
	}
	if (containerMain != null)
	{
		containerMain.FindItemsByItemID(list, id);
	}
	if (containerBelt != 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.