Class playerMenu_leaderboards

The settings for the player menu leaderboards.

Accessors

customStats leaderboards showBannedPlayersInLeaderboards showLastOnlineTimeInPlayerStatsList trackedStats

Subclasses

builtInStats builtInStats

Accessors

StaticcustomStats

  • get customStats(): playerMenuLeaderboardStatistic<
        "custom"
        | "customAdvanced",
        "function" | "order",
    >[]

    The custom leaderboard statistics.

    Dynamic Property ID: andexdbSettings:ui.menus.playerMenu_leaderboards.customStats

    Returns playerMenuLeaderboardStatistic<
        "custom"
        | "customAdvanced",
        "function" | "order",
    >[]

    Default

    []
  • set customStats(
        buttonList: playerMenuLeaderboardStatistic<
            "custom"
            | "customAdvanced",
            "function" | "order",
        >[],
    ): void

    Parameters

    Returns void

Staticleaderboards

  • get leaderboards(): string[]

    The list of statistics that have their own leaderboards, they will be displayed in the order they are in this array.

    It should be an array of ids of leaderboard statistics, including both custom and built-in ones.

    Defaults to the list of the built-in leaderboard statistics from the defaultPlayerMenuLeaderboardStatistics array, in the same order that they appear in the array.

    Dynamic Property ID: andexdbSettings:ui.menus.playerMenu_leaderboards.leaderboards

    Returns string[]

    Default

    defaultPlayerMenuLeaderboardStatistics.map((s) => s.id)
  • set leaderboards(buttonList: string[]): void

    Parameters

    • buttonList: string[]

    Returns void

StaticshowBannedPlayersInLeaderboards

  • get showBannedPlayersInLeaderboards(): boolean

    Whether to show banned players inside of the leaderboards.

    Dynamic Property ID: andexdbSettings:ui.menus.playerMenu_leaderboards.showBannedPlayersInLeaderboards

    Returns boolean

    Default

    false
  • set showBannedPlayersInLeaderboards(show: boolean): void

    Parameters

    • show: boolean

    Returns void

StaticshowLastOnlineTimeInPlayerStatsList

  • get showLastOnlineTimeInPlayerStatsList(): boolean

    Whether to show the time that a player was last online in the stats list that is shown when a player click on another player in a leaderboard.

    Dynamic Property ID: andexdbSettings:ui.menus.playerMenu_leaderboards.showLastOnlineTimeInPlayerStatsList

    Returns boolean

    Default

    false
  • set showLastOnlineTimeInPlayerStatsList(show: boolean): void

    Parameters

    • show: boolean

    Returns void

StatictrackedStats

  • get trackedStats(): string[]

    The statistics that are displayed when a player clicks on another player inside of the player menu leaderboard, they will be displayed in the order they are in this array.

    It should be an array of ids of leaderboard statistics, including both custom and built-in ones.

    Defaults to the list of the built-in leaderboard statistics from the defaultPlayerMenuLeaderboardStatistics array, in the same order that they appear in the array.

    Dynamic Property ID: andexdbSettings:ui.menus.playerMenu_leaderboards.trackedStats

    Returns string[]

    Default

    defaultPlayerMenuLeaderboardStatistics.map((s) => s.id)
  • set trackedStats(buttonList: string[]): void

    Parameters

    • buttonList: string[]

    Returns void

Subclasses

StaticbuiltInStats

  • get builtInStats(): typeof builtInStats

    The settings for the built-in leaderboard statistics.

    Returns typeof builtInStats

Settings

Member Visibility

On This Page

Accessors
Subclasses