OnNpcGiveSoldItem

OxideCarbonNPC

Called when npc give sold item occurs.

object OnNpcGiveSoldItem(NPCVendingMachine nPCVendingMachine, Item soldItem, BasePlayer buyer)

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

Parameters

nPCVendingMachine: NPCVendingMachine
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 OnNpcGiveSoldItem(NPCVendingMachine nPCVendingMachine, Item soldItem, BasePlayer buyer)
{
    Puts("OnNpcGiveSoldItem");

    // 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 NPCVendingMachine.GiveSoldItem(Item, BasePlayer)

Passes: NPCVendingMachine nPCVendingMachine, Item soldItem, BasePlayer buyer

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

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

public override void GiveSoldItem(Item soldItem, BasePlayer buyer)
{
	if (Interface.CallHook("OnNpcGiveSoldItem", this, soldItem, buyer) != null)
	{
		return;
	}
	soldItem.SetItemOwnership(buyer, ItemOwnershipPhrases.VendorSale);
	base.GiveSoldItem(soldItem, buyer);
}

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.