Class EntityFlagUpdateSignal

Hierarchy (View Summary)

EventSignal
- EntityFlagUpdateSignal

Index

Constructors

Properties

entity flag identifier value world identifier

Methods

Constructors

constructor

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

Properties

`Readonly`entity

entity: Entity

The entity in which the flag was updated.

`Readonly`flag

flag: ActorFlag

The flag that was updated.

`Readonly`identifier

identifier: EntityFlagUpdate = WorldEvent.EntityFlagUpdate

The identifier of the signal.

value

value: boolean

The new value of the flag.

`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