Class PlayerUseItemSignal

Hierarchy (View Summary)

EventSignal
- PlayerUseItemSignal
  - PlayerUseItemOnBlockSignal
  - PlayerUseItemOnEntitySignal

Index

Constructors

Properties

identifier itemStack player useMethod world identifier

Methods

Constructors

constructor

new PlayerUseItemSignal(
    player: Player,
    itemStack: ItemStack,
    useMethod: ItemUseMethod,
): PlayerUseItemSignal
Creates a new player use item signal.
Parameters
- player: Player
  The player that used the item.
- itemStack: ItemStack
  The item stack that the player used.
- useMethod: ItemUseMethod
  The method that the player used the item with.
Returns PlayerUseItemSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/player-use-item.ts:33

Properties

`Readonly`identifier

identifier: WorldEvent = ...

The identifier of the signal.

`Readonly`itemStack

itemStack: ItemStack

The item stack that the player used.

`Readonly`player

player: Player

The player that used the item.

`Readonly`useMethod

useMethod: ItemUseMethod

The method that the player used the item with.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: WorldEvent = WorldEvent.PlayerUseItem

The identifier of the signal.

Methods

emit

emit(): boolean
Emits the signal instance.

Returns boolean
Whether the signal was emitted successfully; default is true.
Inherited from EventSignal.emit
- Defined in packages/core/src/events/event-signal.ts:34