Class EntityMetadataUpdateSignal

Hierarchy (View Summary)

EventSignal
- EntityMetadataUpdateSignal

Index

Constructors

Properties

dataItem entity identifier key world identifier

Methods

Constructors

constructor

new EntityMetadataUpdateSignal(
    entity: Entity,
    key: ActorDataId,
    dataItem: DataItem,
): EntityMetadataUpdateSignal
Create a new entity metadata update event.
Parameters
- entity: Entity
  The entity in which the metadata was updated.
- key: ActorDataId
  The metadata key that was updated.
- dataItem: DataItem
  The new value of the metadata.
Returns EntityMetadataUpdateSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/entity-metadata-update.ts:32

Properties

`Readonly`dataItem

dataItem: DataItem

The new value of the metadata.

`Readonly`entity

entity: Entity

The entity in which the metadata was updated.

`Readonly`identifier

identifier: EntityMetadataUpdate = WorldEvent.EntityMetadataUpdate

The identifier of the signal.

`Readonly`key

key: ActorDataId

The metadata key that was updated.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: WorldEvent

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