OnPlayerDropActiveItem

OxideCarbonPlayer

Called when player drop active item occurs.

object OnPlayerDropActiveItem(BasePlayer player, Item local1)

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

Parameters

player: BasePlayer
local1: 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 OnPlayerDropActiveItem(BasePlayer player, Item local1)
{
    Puts("OnPlayerDropActiveItem");

    // 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 PlayerBelt.DropActive(Vector3, Vector3)

Passes: BasePlayer player, Item local1

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

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

// …
}
Item activeItem = player.GetActiveItem();
if (activeItem == null)
{
	return;
}
if (activeItem.GetHeldEntity() is Boomerang { HasThrown: not false })
{
	if (Interface.CallHook("OnPlayerDropActiveItem", this.player, activeItem) != null)
	{
		return;
	}
	activeItem.UseItem();
	if (activeItem.amount == 0)
	{
		activeItem.SetParent(null);
	}
// …

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.