OnItemUnwrap

OxideCarbonItem

Called when item unwrap occurs.

object OnItemUnwrap(Item item, BasePlayer player, ItemModUnwrap itemModUnwrap)

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

Parameters

item: Item
player: BasePlayer
itemModUnwrap: ItemModUnwrap

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 OnItemUnwrap(Item item, BasePlayer player, ItemModUnwrap itemModUnwrap)
{
    Puts("OnItemUnwrap");

    // 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 ItemModUnwrap.ServerCommand(Item, string, BasePlayer)

Passes: Item item, BasePlayer player, ItemModUnwrap itemModUnwrap

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

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

public override void ServerCommand(Item item, string command, BasePlayer player)
{
	if (command == "unwrap" && item.amount > 0)
	{
		if (Interface.CallHook("OnItemUnwrap", item, player, this) != null)
		{
			return;
		}
		item.UseItem();
		int num = Random.Range(minTries, maxTries + 1);
		ItemOwnershipShare ownership = default;
		if (OwnershipPhrase != null && !string.IsNullOrEmpty(OwnershipPhrase.token))
		{
// …

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.