Skip to main content

Class: EntityRemoveAfterEventSignal

Allows registration for an event that fires when an entity is removed from the game (for example, unloaded, or a few seconds after they are dead.)

Constructors

new EntityRemoveAfterEventSignal()

private new EntityRemoveAfterEventSignal(): EntityRemoveAfterEventSignal

Returns

EntityRemoveAfterEventSignal

Methods

subscribe()

subscribe(callback, options?): (arg) => void

Parameters

ParameterTypeDescription
callback(arg) => voidFunction to call.
options?EntityEventOptionsAdditional filtering options for this event.

Returns

Function

Returns a closure that can be used in subsequent unsubscribe operations.

Parameters
ParameterType
argEntityRemoveAfterEvent
Returns

void

Remarks

Will call your function every time an entity is removed from the game.

This function can't be called in read-only mode.


unsubscribe()

unsubscribe(callback): void

Parameters

ParameterType
callback(arg) => void

Returns

void

Remarks

Unsubscribes your function from subsequent calls when an entity is removed.

This function can't be called in read-only mode.

Throws

This function can throw errors.