Class Events_SystemBeforeEvents

A set of events that fire before an actual action occurs. In most cases, you can potentially cancel or modify the impending event. Note that in before events any APIs that modify gameplay state will not function and will throw an error.

Implements

ReplaceTypeOfKey<SystemBeforeEvents, keyof SystemBeforeEvents, any>

Index

Constructors

constructor

Accessors

shutdown startup watchdogTerminate

Constructors

constructor

new Events_SystemBeforeEvents(): Events_SystemBeforeEvents
Returns Events_SystemBeforeEvents
- Defined in init/classes/events.ts:236

Accessors

shutdown

get shutdown(): {
    getAll(): Globals.SubscribedEvent<
        "system.beforeEvents.shutdown",
        ShutdownBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"system.beforeEvents.shutdown">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"system.beforeEvents.shutdown">,
    ): void;
}
Returns {
    getAll(): Globals.SubscribedEvent<
        "system.beforeEvents.shutdown",
        ShutdownBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"system.beforeEvents.shutdown">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"system.beforeEvents.shutdown">,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "system.beforeEvents.shutdown",
    ShutdownBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<
    "system.beforeEvents.shutdown",
    ShutdownBeforeEventSignal,
    >[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:286
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"system.beforeEvents.shutdown">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"system.beforeEvents.shutdown">
    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.
    
    Defined in init/classes/events.ts:251
- unsubscribe:function
  - unsubscribe(
    subscription: Globals.SubscribedEvent<"system.beforeEvents.shutdown">,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"system.beforeEvents.shutdown">
    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.beforeEvents.shutdown event.
    
    Defined in init/classes/events.ts:275
Remarks
This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.shutdown
- Defined in init/classes/events.ts:237

startup

get startup(): {
    getAll(): Globals.SubscribedEvent<
        "system.beforeEvents.startup",
        StartupBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"system.beforeEvents.startup">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"system.beforeEvents.startup">,
    ): void;
}
Returns {
    getAll(): Globals.SubscribedEvent<
        "system.beforeEvents.startup",
        StartupBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"system.beforeEvents.startup">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<"system.beforeEvents.startup">,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "system.beforeEvents.startup",
    StartupBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<"system.beforeEvents.startup", StartupBeforeEventSignal>[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:340
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"system.beforeEvents.startup">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"system.beforeEvents.startup">
    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.
    
    Defined in init/classes/events.ts:305
- unsubscribe:function
  - unsubscribe(
    subscription: Globals.SubscribedEvent<"system.beforeEvents.startup">,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"system.beforeEvents.startup">
    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.beforeEvents.startup event.
    
    Defined in init/classes/events.ts:329
Remarks
This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.startup
- Defined in init/classes/events.ts:291

watchdogTerminate

get watchdogTerminate(): {
    getAll(): Globals.SubscribedEvent<
        "system.beforeEvents.watchdogTerminate",
        WatchdogTerminateBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"system.beforeEvents.watchdogTerminate">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "system.beforeEvents.watchdogTerminate",
        >,
    ): void;
}
Returns {
    getAll(): Globals.SubscribedEvent<
        "system.beforeEvents.watchdogTerminate",
        WatchdogTerminateBeforeEventSignal,
    >[];
    subscribe(
        callback: string,
    ): Globals.SubscribedEvent<"system.beforeEvents.watchdogTerminate">;
    unsubscribe(
        subscription: Globals.SubscribedEvent<
            "system.beforeEvents.watchdogTerminate",
        >,
    ): void;
}
- getAll:function
  - getAll(): Globals.SubscribedEvent<
    "system.beforeEvents.watchdogTerminate",
    WatchdogTerminateBeforeEventSignal,
    >[]
    Gets all event subscriptions to this event type.
    
    Returns Globals.SubscribedEvent<
    "system.beforeEvents.watchdogTerminate",
    WatchdogTerminateBeforeEventSignal,
    >[]
    The event subscriptions.
    
    Defined in init/classes/events.ts:394
- subscribe:function
  - subscribe(
    callback: string,
    ): Globals.SubscribedEvent<"system.beforeEvents.watchdogTerminate">
    Creates a new event subscription.
    
    Parameters
    callback: string
    Returns Globals.SubscribedEvent<"system.beforeEvents.watchdogTerminate">
    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.
    
    Defined in init/classes/events.ts:359
- unsubscribe:function
  - unsubscribe(
        subscription: Globals.SubscribedEvent<
            "system.beforeEvents.watchdogTerminate",
        >,
    ): void
    Deletes the provided event subscription.
    
    Parameters
    subscription: Globals.SubscribedEvent<"system.beforeEvents.watchdogTerminate">
    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.beforeEvents.watchdogTerminate event.
    
    Defined in init/classes/events.ts:383
Remarks
Fires when the scripting watchdog shuts down the server. The can be due to using too much memory, or by causing significant slowdown or hang. To prevent shutdown, set the event's cancel property to true.

This property can be read in early-execution mode.
Implementation of ReplaceTypeOfKey.watchdogTerminate
- Defined in init/classes/events.ts:345

Class Events_SystemBeforeEvents

Implements

Implements

Index

Constructors

Accessors

Constructors

constructor

Returns Events_SystemBeforeEvents

Accessors

shutdown

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

getAll:function

Returns Globals.SubscribedEvent< "system.beforeEvents.shutdown", ShutdownBeforeEventSignal,>[]

subscribe:function

Parameters

Returns Globals.SubscribedEvent<"system.beforeEvents.shutdown">

Remarks

Throws

Throws

Throws

unsubscribe:function

Parameters

Returns void

Remarks

Throws

Throws

Remarks

startup

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

getAll:function

Returns Globals.SubscribedEvent<"system.beforeEvents.startup", StartupBeforeEventSignal>[]

subscribe:function

Parameters

Returns Globals.SubscribedEvent<"system.beforeEvents.startup">

Remarks

Throws

Throws

Throws

unsubscribe:function

Parameters

Returns void

Remarks

Throws

Throws

Remarks

watchdogTerminate

getAll:function

Returns Globals.SubscribedEvent< "system.beforeEvents.watchdogTerminate", WatchdogTerminateBeforeEventSignal,>[]

subscribe:function

Parameters

Returns Globals.SubscribedEvent<"system.beforeEvents.watchdogTerminate">

Remarks

Throws

Throws

Throws

unsubscribe:function

Parameters

Returns void

Remarks

Throws

Throws

Remarks

Settings

On This Page

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

Returns Globals.SubscribedEvent<
"system.beforeEvents.shutdown",
ShutdownBeforeEventSignal,
>[]

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

Returns Globals.SubscribedEvent<
"system.beforeEvents.watchdogTerminate",
WatchdogTerminateBeforeEventSignal,
>[]