OnItemSplit

OxideCarbonItem

Called when item split occurs.

object OnItemSplit(Item item, int split_Amount)

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

Parameters

item: Item
split_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 OnItemSplit(Item item, int split_Amount)
{
    Puts("OnItemSplit");

    // 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 Item.SplitItem(int)

Passes: Item item, int split_Amount

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

// …
if (split_Amount <= 0)
{
	return null;
}
if (split_Amount >= amount)
{
	return null;
}
object returnvar = Interface.CallHook("OnItemSplit", this, split_Amount);
if (returnvar is Item)
{
	return (Item)returnvar;
}
amount -= split_Amount;
Item item = ItemManager.CreateByItemID(info.itemid, split_Amount, skin, 0uL);
MigrateItemOwnership(item, split_Amount);
if (IsBlueprint())
// …

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.