PlayerConsumeEvent

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

public ref struct PlayerConsumeEvent : IEvent

A player finished eating or drinking. Cancel to prevent the effects and the item consumption.

Event

Id	117
Key	mc:player_consume
Cancellable	yes
Fired by the engine	yes

Field	Type	Handlers may write	Description
Player	player	no (readonly)	The player.
Item	item	no (readonly)	The consumed item.
Hand	enum:Hand	no (readonly)	The hand.

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

Constructors

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

Constructor

public PlayerConsumeEvent(Player player, ItemView item, Hand hand)

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
hand	Hand

Properties

Member	Description
bool Cancelled { get; set; }	Cancelling stops lower-priority handlers (unless they opt in) and the action itself.
Hand Hand { get; }	The hand.
ItemView Item { get; }	The consumed item.
Player Player { get; }	The player.
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.

Hand

public Hand Hand { get; }

The hand.

Item

public ItemView Item { get; }

The consumed item.

Player

public Player Player { get; }

The player.

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

Hand · IEvent · ItemView · Player