Class EntityDropItemSignal

Hierarchy (View Summary)

EventSignal
- EntityDropItemSignal

Index

Constructors

Properties

amount identifier itemStack itemStackEntity source world identifier

Methods

Constructors

constructor

new EntityDropItemSignal(
    source: Entity,
    itemStack: ItemStack,
    amount: number,
): EntityDropItemSignal
Creates a new entity drop item signal.
Parameters
- source: Entity
  The entity that dropped the item.
- itemStack: ItemStack
  The item stack that was dropped.
- amount: number
  The amount of itemsource: Entitypped.
Returns EntityDropItemSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/entity-drop-item.ts:37

Properties

`Readonly`amount

amount: number

The amount of items that were dropped.

`Readonly`identifier

identifier: WorldEvent = ...

The identifier of the signal.

`Readonly`itemStack

itemStack: ItemStack

The item stack that was dropped.

itemStackEntity

itemStackEntity: null | Entity = null

The entity instance of the item stack. This is only available in the after event hook.

`Readonly`source

source: Entity

The entity that dropped the item.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: EntityDropItem = WorldEvent.EntityDropItem

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