OnInventoryItemsTake

OxideCarbonItem

Called when inventory items take occurs.

object OnInventoryItemsTake(PlayerInventory playerInventory, List<Item> collect, int itemid, int amount)

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

Parameters

playerInventory: PlayerInventory
collect: List<Item>
itemid: int
amount: 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 OnInventoryItemsTake(PlayerInventory playerInventory, List<Item> collect, int itemid, int amount)
{
    Puts("OnInventoryItemsTake");

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

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

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

Injection point

Rust.opj (Oxide)

int PlayerInventory.Take(List<Item>, int, int)

Passes: PlayerInventory playerInventory, List<Item> collect, int itemid, int amount

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

[PoolAnalyzerNonCaching]
public int Take(List<Item> collect, int itemid, int amount)
{
	object returnvar = Interface.CallHook("OnInventoryItemsTake", this, collect, itemid, amount);
	if (returnvar is int)
	{
		return (int)returnvar;
	}
	int num = 0;
	if (containerMain != null)
	{
		int num2 = containerMain.Take(collect, itemid, amount);
// …

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.