Class Events_SystemAfterEvents

Returns Events_SystemAfterEvents

Returns {
    getAll(): Globals.SubscribedEvent<
        "system.afterEvents.scriptEventReceive",
        ScriptEventCommandMessageAfterEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"system.afterEvents.scriptEventReceive">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "system.afterEvents.scriptEventReceive",
        >,
    ): void;
}

• getAll:function

  • getAll(): Globals.SubscribedEvent<
        "system.afterEvents.scriptEventReceive",
        ScriptEventCommandMessageAfterEventSignal,
    >[]

    Gets all event subscriptions to this event type.

    Returns Globals.SubscribedEvent<
        "system.afterEvents.scriptEventReceive",
        ScriptEventCommandMessageAfterEventSignal,
    >[]

    The event subscriptions.

• subscribe:function

  • subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"system.afterEvents.scriptEventReceive">

    Creates a new event subscription.

    Parameters

    • callback: string

    Returns Globals.SubscribedEvent<"system.afterEvents.scriptEventReceive">

    Remarks

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

    This function can be called in early-execution mode.

    Throws

    If the event callback is an empty string.

    Throws

    If the event callback is not a string.

    Throws

    If the event callback is not a valid stringified JavaScript function.

• unsubscribe:function

  • unsubscribe(
        subscription: Globals.SubscribedEvent<
            "system.afterEvents.scriptEventReceive",
        >,
    ): void

    Deletes the provided event subscription.

    Parameters

    • subscription: Globals.SubscribedEvent<"system.afterEvents.scriptEventReceive">

    Returns void

    Remarks

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

    This function can be called in early-execution mode.

    Throws

    If the subscription is not an instance of SubscribedEvent.

    Throws

    If the subscription is not for the system.afterEvents.scriptEventReceive event.