Class: EntityLoadAfterEventSignal

Registers a script-based event handler for handling what happens when an entity loads.

Constructors

new EntityLoadAfterEventSignal()

private new EntityLoadAfterEventSignal(): EntityLoadAfterEventSignal

Returns

EntityLoadAfterEventSignal

Methods

subscribe()

subscribe(callback): (arg) => void

Parameters

Parameter	Type	Description
callback	(arg) => void	Function that handles the load event.

Returns

Function

Parameters

Parameter	Type
arg	EntityLoadAfterEvent

Returns

void

Remarks

Method to register an event handler for what happens when an entity loads.

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

---

unsubscribe()

unsubscribe(callback): void

Parameters

Parameter	Type	Description
callback	(arg) => void	Original function that was passed into the subscribe event, that is to be unregistered.

Returns

void

Remarks

Unregisters a method that was previously subscribed to the subscription event.

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

Throws

This function can throw errors.