PlayerDropItemEvent

Namespace Mc.Scripting.Events · Kind struct (ref)

public ref struct PlayerDropItemEvent : IEvent

A player drops an item from the hotbar or inventory (drop key). Cancel to keep it.

Event

Id	115
Key	mc:player_drop_item
Cancellable	yes
Fired by the engine	yes

Field	Type	Handlers may write	Description
Player	player	no (readonly)	The player.
Item	item	no (readonly)	The item (a single one, or the whole stack for the control-drop).
WholeStack	bool	no (readonly)	Control-drop of the whole stack.

Set e.Cancelled = true in a handler to cancel it; lower-priority handlers are skipped unless they subscribed with receiveCancelled: true.

Constructors

Member	Description
PlayerDropItemEvent(Player player, ItemView item, bool wholeStack)	Creates the event (for firing it from a plugin; native code builds its own).

Constructor

public PlayerDropItemEvent(Player player, ItemView item, bool wholeStack)

Creates the event (for firing it from a plugin; native code builds its own). Signature of API 1.0.

Parameters

Name	Type	Description
player	Player
item	ItemView
wholeStack	bool

Properties

Member	Description
bool Cancelled { get; set; }	Cancelling stops lower-priority handlers (unless they opt in) and the action itself.
ItemView Item { get; }	The item (a single one, or the whole stack for the control-drop).
Player Player { get; }	The player.
bool WholeStack { get; }	Control-drop of the whole stack.
static ushort CatalogueId { get; }	Catalogue id (stable ABI).
static bool IsCancellable { get; }	Whether handlers can cancel the event.
static string Key { get; }	Registry key of the event.

Cancelled

public bool Cancelled { get; set; }

Cancelling stops lower-priority handlers (unless they opt in) and the action itself.

Item

public ItemView Item { get; }

The item (a single one, or the whole stack for the control-drop).

Player

public Player Player { get; }

The player.

WholeStack

public bool WholeStack { get; }

Control-drop of the whole stack.

CatalogueId

public static ushort CatalogueId { get; }

Catalogue id (stable ABI).

IsCancellable

public static bool IsCancellable { get; }

Whether handlers can cancel the event.

Key

public static string Key { get; }

Registry key of the event.

See also

IEvent · ItemView · Player