Class EntityAttributeUpdateSignal

Hierarchy (View Summary)

EventSignal
- EntityAttributeUpdateSignal

Index

Constructors

Properties

attribute entity identifier value world identifier

Methods

Constructors

constructor

new EntityAttributeUpdateSignal(
    entity: Entity,
    attribute: AttributeName,
    value: Attribute,
): EntityAttributeUpdateSignal
Create a new entity attribute update event.
Parameters
- entity: Entity
  The entity in which the attribute was updated.
- attribute: AttributeName
  The attribute that was updated.
- value: Attribute
  The new value of the attribute.
Returns EntityAttributeUpdateSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/entity-attribute-update.ts:32

Properties

`Readonly`attribute

attribute: AttributeName

The attribute that was updated.

`Readonly`entity

entity: Entity

The entity in which the attribute was updated.

`Readonly`identifier

identifier: WorldEvent = ...

The identifier of the signal.

`Readonly`value

value: Attribute

The new value of the attribute.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: EntityAttributeUpdate = WorldEvent.EntityAttributeUpdate

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