RustTip

OnBuyVendingItem

OxideCarbonVending

Called when buy vending item occurs.

object OnBuyVendingItem(VendingMachine vendingMachine, BasePlayer player, int local0, int local1)
Works — the game method in this build is the one the hook was written for.

Parameters

vendingMachine
VendingMachine
player
BasePlayer
local0
int
local1
int

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 OnBuyVendingItem(VendingMachine vendingMachine, BasePlayer player, int local0, int local1)
{
    Puts("OnBuyVendingItem");

    // 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.BuyItem(BaseEntity.RPCMessage)

Passes: VendingMachine vendingMachine, BasePlayer player, int local0, int local1

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, a0.player, l0, l1)Assembly-CSharp.dll

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

// …
}
int num = rpc.read.Int32();
int numberOfTransactions = rpc.read.Int32();
if (IsVending())
{
	rpc.player.ShowToast(GameTip.Styles.Red_Normal, WaitForVendingMessage, false);
	return;
}
if (Interface.CallHook("OnBuyVendingItem", this, rpc.player, num, numberOfTransactions) != null)
{
	return;
}
int num2 = 0;
for (int i = 0; i < sellOrders.sellOrders.Count; i++)
{
	ItemDefinition itemDefinition = ItemManager.FindItemDefinition(sellOrders.sellOrders[i].itemToSellID);
	ItemDefinition itemDefinition2 = ItemManager.FindItemDefinition(sellOrders.sellOrders[i].currencyID);
// …

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.