Class system

System settings.

Accessors

allowConnectingToBlueModsAnticheat allowConnectingToEntityScale allowWatchdogTerminationCrash artificialLagMS autoSavePlayerData bannedPlayersRefreshRate debugMode defaultMinMSBetweenTickWaits hideWatchdogTerminationCrashEnabledWarningsOnStartup playerDataRefreshRate playerDataSavePerformanceMode playerInventoryDataSaveSystemEnabled protectedAreasRefreshRate protectedAreasZoneActionsEnabled protectedAreasZoneActionsInterval protectedAreasZoneRefreshInterval showBlueModsAnticheatFoundChatLog showBlueModsAnticheatFoundConsoleLog showBlueModsAnticheatNotFoundChatLog showBlueModsAnticheatNotFoundConsoleLog showEntityScaleFoundChatLog showEntityScaleFoundConsoleLog showEntityScaleNotFoundChatLog showEntityScaleNotFoundConsoleLog spreadPlayerInventoryDataSavesOverMultipleTicks timeZone useLegacyPlayerInventoryDataSaveSystem

Accessors

StaticallowConnectingToBlueModsAnticheat

  • get allowConnectingToBlueModsAnticheat(): boolean

    Sets whether or not the add-on is allowed to connect to and communicate with the BlueMods Anticheat add-on.

    Returns boolean

    Warning

    It is HIGHLY DISCOURAGED to disable this option.

  • set allowConnectingToBlueModsAnticheat(
        allowConnectingToBlueModsAnticheat: boolean,
    ): void

    Parameters

    • allowConnectingToBlueModsAnticheat: boolean

    Returns void

StaticallowConnectingToEntityScale

  • get allowConnectingToEntityScale(): boolean

    Sets whether or not the add-on is allowed to connect to and communicate with the entity scale add-on.

    Returns boolean

    Warning

    It is HIGHLY DISCOURAGED to disable this option.

  • set allowConnectingToEntityScale(allowConnectingToEntityScale: boolean): void

    Parameters

    • allowConnectingToEntityScale: boolean

    Returns void

StaticallowWatchdogTerminationCrash

  • get allowWatchdogTerminationCrash(): boolean

    It is recommended to leave this set to false.

    Dynamic Property ID: andexdbSettings:allowWatchdogTerminationCrash

    Returns boolean

    Default

    false
  • set allowWatchdogTerminationCrash(allowWatchdogTerminationCrash: boolean): void

    Parameters

    • allowWatchdogTerminationCrash: boolean

    Returns void

StaticartificialLagMS

  • get artificialLagMS(): number

    Returns number

  • set artificialLagMS(artificialLagMS: number): void

    Parameters

    • artificialLagMS: number

    Returns void

StaticautoSavePlayerData

  • get autoSavePlayerData(): boolean

    Returns boolean

  • set autoSavePlayerData(autoSavePlayerData: boolean): void

    Parameters

    • autoSavePlayerData: boolean

    Returns void

StaticbannedPlayersRefreshRate

  • get bannedPlayersRefreshRate(): number

    How often in ticks to check for banned players.

    Dynamic Property ID: andexdbSettings:bannedPlayersRefreshRate

    Returns number

    Default

    20
  • set bannedPlayersRefreshRate(bannedPlayersRefreshRate: number): void

    Parameters

    • bannedPlayersRefreshRate: number

    Returns void

StaticdebugMode

  • get debugMode(): boolean

    Returns boolean

  • set debugMode(debugMode: boolean): void

    Parameters

    • debugMode: boolean

    Returns void

StaticdefaultMinMSBetweenTickWaits

  • get defaultMinMSBetweenTickWaits(): number

    The default minimum time between tick waits, in milliseconds.

    This will be the minimum amount of milliseconds that many generation functions will spend each tick, set this to a really low value to reduce lag while using them, but setting it really low will also cause the generation functions to take a really long time.

    Setting it close to or above 10000 may cause the generation functions to be interrupted with script hang errors.

    Returns number

    Default

    2500
  • set defaultMinMSBetweenTickWaits(defaultMinMSBetweenTickWaits: number): void

    Parameters

    • defaultMinMSBetweenTickWaits: number

    Returns void

StatichideWatchdogTerminationCrashEnabledWarningsOnStartup

  • get hideWatchdogTerminationCrashEnabledWarningsOnStartup(): boolean

    It is recommended to leave this set to false.

    Dynamic Property ID: andexdbSettings:hideWatchdogTerminationCrashEnabledWarningsOnStartup

    Returns boolean

    Default

    false
  • set hideWatchdogTerminationCrashEnabledWarningsOnStartup(
        hideWatchdogTerminationCrashEnabledWarningsOnStartup: boolean,
    ): void

    Parameters

    • hideWatchdogTerminationCrashEnabledWarningsOnStartup: boolean

    Returns void

StaticplayerDataRefreshRate

  • get playerDataRefreshRate(): number

    Returns number

  • set playerDataRefreshRate(playerDataRefreshRate: number): void

    Parameters

    • playerDataRefreshRate: number

    Returns void

StaticplayerDataSavePerformanceMode

StaticplayerInventoryDataSaveSystemEnabled

  • get playerInventoryDataSaveSystemEnabled(): boolean

    Returns boolean

  • set playerInventoryDataSaveSystemEnabled(
        playerInventoryDataSaveSystemEnabled: boolean,
    ): void

    Parameters

    • playerInventoryDataSaveSystemEnabled: boolean

    Returns void

StaticprotectedAreasRefreshRate

  • get protectedAreasRefreshRate(): number

    How often to refresh protected areas.

    Dynamic Property ID: andexdbSettings:protectedAreasRefreshRate

    Returns number

    Default

    200

    Deprecated

  • set protectedAreasRefreshRate(protectedAreasRefreshRate: number): void

    Parameters

    • protectedAreasRefreshRate: number

    Returns void

StaticprotectedAreasZoneActionsEnabled

  • get protectedAreasZoneActionsEnabled(): boolean

    Whether to enable zone actions for protected areas.

    Dynamic Property ID: andexdbSettings:protectedAreasZoneActionsEnabled

    Returns boolean

    Default

    true
  • set protectedAreasZoneActionsEnabled(
        protectedAreasZoneActionsEnabled: boolean,
    ): void

    Parameters

    • protectedAreasZoneActionsEnabled: boolean

    Returns void

StaticprotectedAreasZoneActionsInterval

  • get protectedAreasZoneActionsInterval(): number

    How often in ticks to execute the zone actions.

    Dynamic Property ID: andexdbSettings:protectedAreasZoneActionsInterval

    Returns number

    Default

    5
  • set protectedAreasZoneActionsInterval(
        protectedAreasZoneActionsInterval: number,
    ): void

    Parameters

    • protectedAreasZoneActionsInterval: number

    Returns void

StaticprotectedAreasZoneRefreshInterval

  • get protectedAreasZoneRefreshInterval(): number

    How often in milliseconds to refresh the list of protected areas zones with zone actions.

    Dynamic Property ID: andexdbSettings:protectedAreasZoneRefreshInterval

    Returns number

    Default

    200
  • set protectedAreasZoneRefreshInterval(
        protectedAreasZoneRefreshInterval: number,
    ): void

    Parameters

    • protectedAreasZoneRefreshInterval: number

    Returns void

StaticshowBlueModsAnticheatFoundChatLog

  • get showBlueModsAnticheatFoundChatLog(): boolean

    Returns boolean

  • set showBlueModsAnticheatFoundChatLog(
        showBlueModsAnticheatFoundChatLog: boolean,
    ): void

    Parameters

    • showBlueModsAnticheatFoundChatLog: boolean

    Returns void

StaticshowBlueModsAnticheatFoundConsoleLog

  • get showBlueModsAnticheatFoundConsoleLog(): boolean

    Returns boolean

  • set showBlueModsAnticheatFoundConsoleLog(
        showBlueModsAnticheatFoundConsoleLog: boolean,
    ): void

    Parameters

    • showBlueModsAnticheatFoundConsoleLog: boolean

    Returns void

StaticshowBlueModsAnticheatNotFoundChatLog

  • get showBlueModsAnticheatNotFoundChatLog(): boolean

    Returns boolean

  • set showBlueModsAnticheatNotFoundChatLog(
        showBlueModsAnticheatNotFoundChatLog: boolean,
    ): void

    Parameters

    • showBlueModsAnticheatNotFoundChatLog: boolean

    Returns void

StaticshowBlueModsAnticheatNotFoundConsoleLog

  • get showBlueModsAnticheatNotFoundConsoleLog(): boolean

    Returns boolean

  • set showBlueModsAnticheatNotFoundConsoleLog(
        showBlueModsAnticheatNotFoundConsoleLog: boolean,
    ): void

    Parameters

    • showBlueModsAnticheatNotFoundConsoleLog: boolean

    Returns void

StaticshowEntityScaleFoundChatLog

  • get showEntityScaleFoundChatLog(): boolean

    Returns boolean

  • set showEntityScaleFoundChatLog(showEntityScaleFoundChatLog: boolean): void

    Parameters

    • showEntityScaleFoundChatLog: boolean

    Returns void

StaticshowEntityScaleFoundConsoleLog

  • get showEntityScaleFoundConsoleLog(): boolean

    Returns boolean

  • set showEntityScaleFoundConsoleLog(
        showEntityScaleFoundConsoleLog: boolean,
    ): void

    Parameters

    • showEntityScaleFoundConsoleLog: boolean

    Returns void

StaticshowEntityScaleNotFoundChatLog

  • get showEntityScaleNotFoundChatLog(): boolean

    Returns boolean

  • set showEntityScaleNotFoundChatLog(
        showEntityScaleNotFoundChatLog: boolean,
    ): void

    Parameters

    • showEntityScaleNotFoundChatLog: boolean

    Returns void

StaticshowEntityScaleNotFoundConsoleLog

  • get showEntityScaleNotFoundConsoleLog(): boolean

    Returns boolean

  • set showEntityScaleNotFoundConsoleLog(
        showEntityScaleNotFoundConsoleLog: boolean,
    ): void

    Parameters

    • showEntityScaleNotFoundConsoleLog: boolean

    Returns void

StaticspreadPlayerInventoryDataSavesOverMultipleTicks

  • get spreadPlayerInventoryDataSavesOverMultipleTicks(): boolean

    Returns boolean

  • set spreadPlayerInventoryDataSavesOverMultipleTicks(
        spreadPlayerInventoryDataSavesOverMultipleTicks: boolean,
    ): void

    Parameters

    • spreadPlayerInventoryDataSavesOverMultipleTicks: boolean

    Returns void

StatictimeZone

  • get timeZone(): number

    Returns number

  • set timeZone(timeZone: number): void

    Parameters

    • timeZone: number

    Returns void

StaticuseLegacyPlayerInventoryDataSaveSystem

  • get useLegacyPlayerInventoryDataSaveSystem(): boolean

    It is recommended to leave this set to false.

    Dynamic Property ID: andexdbSettings:useLegacyPlayerInventoryDataSaveSystem

    Returns boolean

    Default

    false
  • set useLegacyPlayerInventoryDataSaveSystem(
        useLegacyPlayerInventoryDataSaveSystem: boolean,
    ): void

    Parameters

    • useLegacyPlayerInventoryDataSaveSystem: boolean

    Returns void

Settings

Member Visibility

On This Page

Accessors
allowConnectingToBlueModsAnticheatallowConnectingToEntityScaleallowWatchdogTerminationCrashartificialLagMSautoSavePlayerDatabannedPlayersRefreshRatedebugModedefaultMinMSBetweenTickWaitshideWatchdogTerminationCrashEnabledWarningsOnStartupplayerDataRefreshRateplayerDataSavePerformanceModeplayerInventoryDataSaveSystemEnabledprotectedAreasRefreshRateprotectedAreasZoneActionsEnabledprotectedAreasZoneActionsIntervalprotectedAreasZoneRefreshIntervalshowBlueModsAnticheatFoundChatLogshowBlueModsAnticheatFoundConsoleLogshowBlueModsAnticheatNotFoundChatLogshowBlueModsAnticheatNotFoundConsoleLogshowEntityScaleFoundChatLogshowEntityScaleFoundConsoleLogshowEntityScaleNotFoundChatLogshowEntityScaleNotFoundConsoleLogspreadPlayerInventoryDataSavesOverMultipleTickstimeZoneuseLegacyPlayerInventoryDataSaveSystem