OnItemFilter

OxideCarbonItem

Called when item filter occurs.

object OnItemFilter(Item item, StorageContainer storageContainer, int targetSlot, BasePlayer player)

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

Parameters

item: Item
storageContainer: StorageContainer
targetSlot: int
player: BasePlayer

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 OnItemFilter(Item item, StorageContainer storageContainer, int targetSlot, BasePlayer player)
{
    Puts("OnItemFilter");

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

    // to affect the game:
    // return false; // your value instead of the game result
}

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

Injection point

Rust.opj (Oxide)

bool StorageContainer.ItemFilter(BasePlayer, Item, int)

Passes: Item item, StorageContainer storageContainer, int targetSlot, BasePlayer player

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

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

public virtual bool ItemFilter(BasePlayer player, Item item, int targetSlot)
{
	object returnvar = Interface.CallHook("OnItemFilter", item, this, targetSlot, player);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if (onlyAcceptCategory == ItemCategory.All)
	{
		return true;
	}
// …

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.