Class EntityHealthChangedSignal

Hierarchy (View Summary)

EventSignal
- EntityHealthChangedSignal

Index

Constructors

constructor

new EntityHealthChangedSignal(
    entity: Entity,
    fromHealth: number,
    toHealth: number,
): EntityHealthChangedSignal
Parameters
- entity: Entity
- fromHealth: number
- toHealth: number
Returns EntityHealthChangedSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/entity-health-changed.ts:24

Properties

`Readonly`entity

entity: Entity

The entity which health changed.

`Readonly`fromHealth

fromHealth: number

The previous health value.

`Readonly`identifier

identifier: WorldEvent = ...

The identifier of the signal.

`Readonly`toHealth

toHealth: number

The new health value.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: WorldEvent = WorldEvent.HealthChanged

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

Class EntityHealthChangedSignal

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EntityHealthChangedSignal

Properties

`Readonly`entity

`Readonly`fromHealth

`Readonly`identifier

`Readonly`toHealth

`Readonly`world

`Static` `Readonly`identifier

Methods

emit

Returns boolean

Settings

On This Page

Class EntityHealthChangedSignal

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EntityHealthChangedSignal

Properties

Readonlyentity

ReadonlyfromHealth

Readonlyidentifier

ReadonlytoHealth

Readonlyworld

Static Readonlyidentifier

Methods

emit

Returns boolean

Settings

On This Page

`Readonly`entity

`Readonly`fromHealth

`Readonly`identifier

`Readonly`toHealth

`Readonly`world

`Static` `Readonly`identifier