Class EntityItemPickupSignal

Hierarchy (View Summary)

EventSignal
- EntityItemPickupSignal

Index

Constructors

Properties

identifier itemStack source world identifier

Methods

Constructors

constructor

new EntityItemPickupSignal(
source: Entity,
itemStack: ItemStack,
): EntityItemPickupSignal
Creates a new entity item signal.
Parameters
- source: Entity
  The entity that picked up the item.
- itemStack: ItemStack
  The item stack that was picked up.
Returns EntityItemPickupSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/entity-item-pickup.ts:25

Properties

`Readonly`identifier

identifier: WorldEvent = ...

The identifier of the signal.

`Readonly`itemStack

itemStack: ItemStack

The item stack that was picked up.

`Readonly`source

source: Entity

The entity that picked up the item.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: EntityItemPickup = WorldEvent.EntityItemPickup

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

emitAsync

emitAsync(): Promise<boolean>
Emits the signal instance asynchronously.

Returns Promise<boolean>
Whether the signal was emitted successfully; default is true.
Inherited from EventSignal.emitAsync
- Defined in packages/core/src/events/event-signal.ts:47