Class playerMenu

The player menu settings.

Index

Accessors

buttons enabled itemName showDeprecatedButtons showExperimentalButtons showNonFunctionalButtons showUnusedButtons showUpcomingButtons

Accessors

`Static`buttons

The buttons to show on the player menu. They will appear in the order that they are specified in this option.

Dynamic Property ID: andexdbSettings:ui.menus.playerMenu.buttons

Returns (
    | "leaderboards"
    | "homes"
    | "TPA"
    | "warps"
    | "bounties"
    | "serverShops"
    | "playerShops"
    | "moneyTransfer"
    | "dailyRewards"
    | "redeemCode"
    | "about"
)[]

Default

JSON.stringify(
   (Object.keys(menuButtonIds.playerMenu.buttons) as (keyof typeof menuButtonIds.playerMenu.buttons)[]).sort(
       (a, b) =>
           menuButtonIds.playerMenu.buttons[a].defaultButtonIndex >
           menuButtonIds.playerMenu.buttons[b].defaultButtonIndex
               ? 1
               : menuButtonIds.playerMenu.buttons[a].defaultButtonIndex <
                 menuButtonIds.playerMenu.buttons[b].defaultButtonIndex
               ? -1
               : 0
   )
)

set buttons(
    buttonList:
        | undefined
        | (
            | "leaderboards"
            | "homes"
            | "TPA"
            | "warps"
            | "bounties"
            | "serverShops"
            | "playerShops"
            | "moneyTransfer"
            | "dailyRewards"
            | "redeemCode"
            | "about"
        )[],
): void
Parameters
- buttonList:
      | undefined
      | (
          | "leaderboards"
          | "homes"
          | "TPA"
          | "warps"
          | "bounties"
          | "serverShops"
          | "playerShops"
          | "moneyTransfer"
          | "dailyRewards"
          | "redeemCode"
          | "about"
      )[]
Returns void
- Defined in init/classes/config.ts:2098

`Static`enabled

get enabled(): boolean
Whether or not the player menu is enabled.

Dynamic Property ID: andexdbSettings:ui.menus.playerMenu.enabled

Returns boolean
Default
```
true
```
- Defined in init/classes/config.ts:2055
set enabled(enabled: undefined | boolean): void
Parameters
- enabled: undefined | boolean
Returns void
- Defined in init/classes/config.ts:2058

`Static`itemName

get itemName(): string
The item name for the item that opens the player menu.

Dynamic Property ID: andexdbSettings:ui.menus.playerMenu.itemName

Returns string
Default
```
"Menu"
```
- Defined in init/classes/config.ts:2123
set itemName(itemName: undefined | string): void
Parameters
- itemName: undefined | string
Returns void
- Defined in init/classes/config.ts:2126

`Static`showDeprecatedButtons

get showDeprecatedButtons(): boolean
Whether to show the buttons marked as deprecated on the player menu.

Dynamic Property ID: andexdbSettings:ui.menus.playerMenu.showDeprecatedButtons

Returns boolean
Default
```
false
```
- Defined in init/classes/config.ts:2136
set showDeprecatedButtons(show: undefined | boolean): void
Parameters
- show: undefined | boolean
Returns void
- Defined in init/classes/config.ts:2139

`Static`showExperimentalButtons

get showExperimentalButtons(): boolean
Whether to show the buttons marked as deprecated on the player menu.

Dynamic Property ID: andexdbSettings:ui.menus.playerMenu.showExperimentalButtons

Returns boolean
Default
```
true
```
- Defined in init/classes/config.ts:2149
set showExperimentalButtons(show: undefined | boolean): void
Parameters
- show: undefined | boolean
Returns void
- Defined in init/classes/config.ts:2152

`Static`showNonFunctionalButtons

get showNonFunctionalButtons(): boolean
Whether to show the buttons for features that are non-functional on the player menu.

Dynamic Property ID: andexdbSettings:ui.menus.playerMenu.showNonFunctionalButtons

Returns boolean
Default
```
false
```
- Defined in init/classes/config.ts:2188
set showNonFunctionalButtons(show: undefined | boolean): void
Parameters
- show: undefined | boolean
Returns void
- Defined in init/classes/config.ts:2191

`Static`showUnusedButtons

get showUnusedButtons(): boolean
Whether to show the buttons marked as deprecated on the player menu.

Dynamic Property ID: andexdbSettings:ui.menus.playerMenu.showUnusedButtons

Returns boolean
Default
```
false
```
- Defined in init/classes/config.ts:2162
set showUnusedButtons(show: undefined | boolean): void
Parameters
- show: undefined | boolean
Returns void
- Defined in init/classes/config.ts:2165

`Static`showUpcomingButtons

get showUpcomingButtons(): boolean
Whether to show the buttons for features that are planned to be added in a future update on the player menu.

Dynamic Property ID: andexdbSettings:ui.menus.playerMenu.showUpcomingButtons

Returns boolean
Default
```
false
```
- Defined in init/classes/config.ts:2175
set showUpcomingButtons(show: undefined | boolean): void
Parameters
- show: undefined | boolean
Returns void
- Defined in init/classes/config.ts:2178

Class playerMenu

Index

Accessors

Accessors

Staticbuttons

Returns ( | "leaderboards" | "homes" | "TPA" | "warps" | "bounties" | "serverShops" | "playerShops" | "moneyTransfer" | "dailyRewards" | "redeemCode" | "about")[]

Default

Parameters

Returns void

Staticenabled

Returns boolean

Default

Parameters

Returns void

StaticitemName

Returns string

Default

Parameters

Returns void

StaticshowDeprecatedButtons

Returns boolean

Default

Parameters

Returns void

StaticshowExperimentalButtons

Returns boolean

Default

Parameters

Returns void

StaticshowNonFunctionalButtons

Returns boolean

Default

Parameters

Returns void

StaticshowUnusedButtons

Returns boolean

Default

Parameters

Returns void

StaticshowUpcomingButtons

Returns boolean

Default

Parameters

Returns void

Settings

On This Page

`Static`buttons

Returns (
| "leaderboards"
| "homes"
| "TPA"
| "warps"
| "bounties"
| "serverShops"
| "playerShops"
| "moneyTransfer"
| "dailyRewards"
| "redeemCode"
| "about"
)[]

`Static`enabled

`Static`itemName

`Static`showDeprecatedButtons

`Static`showExperimentalButtons

`Static`showNonFunctionalButtons

`Static`showUnusedButtons

`Static`showUpcomingButtons