OnTakeCurrencyItem

OxideCarbonVending

Called when take currency item occurs.

object OnTakeCurrencyItem(VendingMachine vendingMachine, Item takenCurrencyItem)
object OnTakeCurrencyItem(NPCVendingMachine nPCVendingMachine, Item takenCurrencyItem)

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

Parameters

vendingMachine: VendingMachine
takenCurrencyItem: Item

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 OnTakeCurrencyItem(VendingMachine vendingMachine, Item takenCurrencyItem)
{
    Puts("OnTakeCurrencyItem");

    // 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 1

Rust.opj (Oxide)

void VendingMachine.TakeCurrencyItem(Item)

Passes: VendingMachine vendingMachine, Item takenCurrencyItem

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

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

public virtual void TakeCurrencyItem(Item takenCurrencyItem)
{
	if (Interface.CallHook("OnTakeCurrencyItem", this, takenCurrencyItem) != null)
	{
		return;
	}
	if (!takenCurrencyItem.MoveToContainer(inventory))
	{
		takenCurrencyItem.Drop(inventory.dropPosition, Vector3.zero);
	}
}

Injection point 2

Rust.opj (Oxide)

void NPCVendingMachine.TakeCurrencyItem(Item)

Passes: NPCVendingMachine nPCVendingMachine, Item takenCurrencyItem

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

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

public override void TakeCurrencyItem(Item takenCurrencyItem)
{
	if (Interface.CallHook("OnTakeCurrencyItem", this, takenCurrencyItem) != null)
	{
		return;
	}
	takenCurrencyItem.MoveToContainer(inventory);
	takenCurrencyItem.RemoveFromContainer();
	takenCurrencyItem.Remove();
}

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.