OnGiveSoldItem

OxideCarbonVending

Called when give sold item occurs.

object OnGiveSoldItem(VendingMachine vendingMachine, Item soldItem, BasePlayer buyer)

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

Parameters

vendingMachine: VendingMachine
soldItem: Item
buyer: BasePlayer

Return value

objectReturn non-null to cancel the game action.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnGiveSoldItem(VendingMachine vendingMachine, Item soldItem, BasePlayer buyer)
{
    Puts("OnGiveSoldItem");

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

    // to affect the game:
    // return false; // non-null cancels the game action
}

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

Injection point

Rust.opj (Oxide)

void VendingMachine.GiveSoldItem(Item, BasePlayer)

Passes: VendingMachine vendingMachine, Item soldItem, BasePlayer buyer

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

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

public virtual void GiveSoldItem(Item soldItem, BasePlayer buyer)
if (Interface.CallHook("OnGiveSoldItem", this, soldItem, buyer) != null)
{
	return;
}
{
	while (soldItem.amount > soldItem.MaxStackable())
	{
		Item item = soldItem.SplitItem(soldItem.MaxStackable());
		buyer.GiveItem(item, GiveItemReason.PickedUp);
// …

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.