RustTip

OnMaxStackable

OxideCarbonItem

Called when max stackable occurs.

object OnMaxStackable(Item item)
Works — the game method in this build is the one the hook was written for.

Parameters

item
Item

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 OnMaxStackable(Item item)
{
    Puts("OnMaxStackable");

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

Passes: Item item

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThis (this => l0)Assembly-CSharp.dll

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

public int MaxStackable()
{
	int num = info.stackable;
	if (parent != null && parent.maxStackSize > 0)
	{
		num = ((!parent.allowItemsToIncreaseToMaxStackSize) ? Mathf.Min(parent.maxStackSize, num) : Mathf.Max(parent.maxStackSize, num));
	}
	object returnvar = Interface.CallHook("OnMaxStackable", this);
	if (returnvar is int)
	{
		return (int)returnvar;
	}
	return num;
}

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.