Class EntityHitSignal

Hierarchy (View Summary)

EventSignal
- EntityHitSignal

Index

Constructors

Properties

damagingEntity hitEntity identifier world identifier

Methods

Constructors

constructor

new EntityHitSignal(damagingEntity: Entity, hitEntity: Entity): EntityHitSignal
Parameters
- damagingEntity: Entity
- hitEntity: Entity
Returns EntityHitSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/entity-hit.ts:19

Properties

`Readonly`damagingEntity

damagingEntity: Entity

The entity that hitted the other entity.

`Readonly`hitEntity

hitEntity: Entity

The entity that was hit.

`Readonly`identifier

identifier: WorldEvent = ...

The identifier of the signal.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: WorldEvent = WorldEvent.EntityHit

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

emitAsync

emitAsync(): Promise<boolean>
Emits the signal instance asynchronously.

Returns Promise<boolean>
Whether the signal was emitted successfully; default is true.
Inherited from EventSignal.emitAsync
- Defined in packages/core/src/events/event-signal.ts:47