Supports registering for an event that fires after an entity has died.

Hierarchy

  • EntityDieAfterEventSignal

Constructors

Methods

Constructors

Methods

  • Parameters

    • callback: ((arg) => void)

      Function to call when an entity dies.

    • Optional options: EntityEventOptions

      Additional filtering options for when the subscription fires.

      Optional

    Returns ((arg) => void)

    Returns the closure that can be used in future downstream calls to unsubscribe.

      • (arg): void
      • Parameters

        Returns void

        Returns the closure that can be used in future downstream calls to unsubscribe.

        Remarks

        Subscribes to an event that fires when an entity dies.

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

    Remarks

    Subscribes to an event that fires when an entity dies.

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

  • Parameters

    Returns void

    Remarks

    Stops this event from calling your function when an entity dies.

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

    Throws

    This function can throw errors.