Class PlayerAbilityUpdateSignal

Hierarchy (View Summary)

EventSignal
- PlayerAbilityUpdateSignal

Index

Constructors

Properties

ability identifier player value world identifier

Methods

Constructors

constructor

new PlayerAbilityUpdateSignal(
    player: Player,
    ability: AbilityIndex,
    value: boolean,
): PlayerAbilityUpdateSignal
Create a new player ability update event.
Parameters
- player: Player
  The player in which the ability was updated.
- ability: AbilityIndex
  The ability that was updated.
- value: boolean
  The new value of the ability.
Returns PlayerAbilityUpdateSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/player-ability-update.ts:32

Properties

`Readonly`ability

ability: AbilityIndex

The ability that was updated.

`Readonly`identifier

identifier: WorldEvent = ...

The identifier of the signal.

`Readonly`player

player: Player

The player in which the ability was updated.

value

value: boolean

The new value of the ability.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: PlayerAbilityUpdate = WorldEvent.PlayerAbilityUpdate

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