Class EntityHurtSignal

Hierarchy (View Summary)

EventSignal
- EntityHurtSignal

Index

Constructors

Properties

amount cause? damagingEntity? hurtEntity identifier world identifier

Methods

Constructors

constructor

new EntityHurtSignal(
    hurtEntity: Entity,
    amount: number,
    cause?: ActorDamageCause,
    damagingEntity?: Entity,
): EntityHurtSignal
Parameters
- hurtEntity: Entity
- amount: number
- Optionalcause: ActorDamageCause
- OptionaldamagingEntity: Entity
Returns EntityHurtSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/entity-hurt.ts:31

Properties

amount

amount: number

The amount of damage dealed to the entity.

`Optional`cause

cause?: ActorDamageCause

The cause of the damage dealed to the entity

`Optional` `Readonly`damagingEntity

damagingEntity?: Entity

The entity that hurted the entity, if the damage was caused by an entity.

`Readonly`hurtEntity

hurtEntity: Entity

The entity that was hurt.

`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.EntityHurt

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