Class EntityLoadAfterEventSignal

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

Hierarchy

  • EntityLoadAfterEventSignal

Constructors

constructor

Methods

subscribe unsubscribe

Constructors

Private constructor

Methods

subscribe

  • Parameters

    • callback: ((arg) => void)

      Function that handles the load event.

    Returns ((arg) => void)

      • (arg): void

      • Parameters

        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.

        This function can be called in early-execution mode.

    Remarks

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

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

    This function can be called in early-execution mode.

unsubscribe

  • Parameters

    • 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.

    This function can be called in early-execution mode.

Settings

Member Visibility

Theme

On This Page