Class EntityDiedSignal

Hierarchy (View Summary)

EventSignal
- EntityDiedSignal

Index

Constructors

Properties

damageCause identifier killerSource targetEntity world identifier

Methods

Constructors

constructor

new EntityDiedSignal(
entity: Entity,
options: EntityDeathOptions,
): EntityDiedSignal
Creates a new entity died signal.
Parameters
- entity: Entity
  The entity that died.
- options: EntityDeathOptions
  The options of the entity death.
Returns EntityDiedSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/entity-die.ts:32

Properties

`Readonly`damageCause

damageCause: ActorDamageCause

The last damage cause before the entity death.

`Readonly`identifier

identifier: WorldEvent = ...

The identifier of the signal.

`Readonly`killerSource

killerSource: null | Entity

The entity that killed the entity, only if the death was caused by an entity.

`Readonly`targetEntity

targetEntity: Entity

The entity that died.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: WorldEvent = WorldEvent.EntityDied

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