OnInventoryItemFind

OxideCarbonItem

Called when an inventory item is found.

object OnInventoryItemFind(PlayerInventory playerInventory, int id)

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

Parameters

playerInventory: PlayerInventory
id: int

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 OnInventoryItemFind(PlayerInventory playerInventory, int id)
{
    Puts("OnInventoryItemFind");

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

    // to affect the game:
    // return default(Item); // your value instead of the game result
}

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

Injection point

Rust.opj (Oxide)

Item PlayerInventory.FindItemByItemID(int)

Passes: PlayerInventory playerInventory, int id

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

public Item FindItemByItemID(int id)
{
	object returnvar = Interface.CallHook("OnInventoryItemFind", this, id);
	if (returnvar is Item)
	{
		return (Item)returnvar;
	}
	if (containerMain != null)
	{
		Item item = containerMain.FindItemByItemID(id);
		if (item != null && item.IsValid())
// …

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.