OnBackpackDrop

OxideCarbonItem

Called when a backpack is dropped.

object OnBackpackDrop(Item local0, PlayerInventory playerInventory)

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

Parameters

local0: Item
playerInventory: PlayerInventory

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 OnBackpackDrop(Item local0, PlayerInventory playerInventory)
{
    Puts("OnBackpackDrop");

    // 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 PlayerInventory.TryDropBackpack()

Passes: Item local0, PlayerInventory playerInventory

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

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

public void TryDropBackpack()
{
	Item anyBackpack = GetAnyBackpack();
	if (anyBackpack != null && baseEntity.isServer)
	{
		if (Interface.CallHook("OnBackpackDrop", anyBackpack, this) != null)
		{
			return;
		}
		anyBackpack.Drop(baseEntity.GetDropPosition(), baseEntity.GetDropVelocity());
	}
}

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.