Class chatRanks

The chat and name tags settings.

Accessors

`Static`allowChatEscapeCodes

get allowChatEscapeCodes(): boolean
Returns boolean
- Defined in init/classes/config.ts:1208
set allowChatEscapeCodes(allowChatEscapeCodes: boolean): void
Parameters
- allowChatEscapeCodes: boolean
Returns void
- Defined in init/classes/config.ts:1211

`Static`allowCustomChatMessagesMuting

get allowCustomChatMessagesMuting(): boolean
Returns boolean
- Defined in init/classes/config.ts:1190
set allowCustomChatMessagesMuting(allowCustomChatMessagesMuting: boolean): void
Parameters
- allowCustomChatMessagesMuting: boolean
Returns void
- Defined in init/classes/config.ts:1193

`Static`autoEscapeChatMessages

get autoEscapeChatMessages(): boolean
Returns boolean
- Defined in init/classes/config.ts:1196
set autoEscapeChatMessages(autoEscapeChatMessages: boolean): void
Parameters
- autoEscapeChatMessages: boolean
Returns void
- Defined in init/classes/config.ts:1199

`Static`autoURIEscapeChatMessages

get autoURIEscapeChatMessages(): boolean
Returns boolean
- Defined in init/classes/config.ts:1202
set autoURIEscapeChatMessages(autoURIEscapeChatMessages: boolean): void
Parameters
- autoURIEscapeChatMessages: boolean
Returns void
- Defined in init/classes/config.ts:1205

`Static`chatDimensionTemplateString

get chatDimensionTemplateString(): string
The template string for displaying a player's dimension in the chat.

Only applies in Custom(Advanced) mode.

Returns string
Todo
Default
```
"[${dimension}§r] "
```
- Defined in init/classes/config.ts:1118
set chatDimensionTemplateString(chatDimensionTemplateString: string): void
Parameters
- chatDimensionTemplateString: string
Returns void
- Defined in init/classes/config.ts:1121

`Static`chatDisplayTimeStamp

get chatDisplayTimeStamp(): boolean
Returns boolean
- Defined in init/classes/config.ts:1022
set chatDisplayTimeStamp(chatDisplayTimeStampEnabled: boolean): void
Parameters
- chatDisplayTimeStampEnabled: boolean
Returns void
- Defined in init/classes/config.ts:1025

`Static`chatNameAndMessageSeparator

get chatNameAndMessageSeparator(): string
Returns string
- Defined in init/classes/config.ts:1097
set chatNameAndMessageSeparator(chatNameAndMessageSeparator: string): void
Parameters
- chatNameAndMessageSeparator: string
Returns void
- Defined in init/classes/config.ts:1100

`Static`chatRankPrefix

get chatRankPrefix(): string
Returns string
- Defined in init/classes/config.ts:1010
set chatRankPrefix(chatRankPrefix: string): void
Parameters
- chatRankPrefix: string
Returns void
- Defined in init/classes/config.ts:1013

`Static`chatSudoPrefix

get chatSudoPrefix(): string
Returns string
- Defined in init/classes/config.ts:1016
set chatSudoPrefix(chatSudoPrefix: string): void
Parameters
- chatSudoPrefix: string
Returns void
- Defined in init/classes/config.ts:1019

`Static`defaultMessageFormatting

get defaultMessageFormatting(): string
Returns string
- Defined in init/classes/config.ts:1166
set defaultMessageFormatting(defaultMessageFormatting: string): void
Parameters
- defaultMessageFormatting: string
Returns void
- Defined in init/classes/config.ts:1169

`Static`defaultNameFormatting

get defaultNameFormatting(): string
Returns string
- Defined in init/classes/config.ts:1172
set defaultNameFormatting(defaultNameFormatting: string): void
Parameters
- defaultNameFormatting: string
Returns void
- Defined in init/classes/config.ts:1175

`Static`defaultRank

get defaultRank(): string
Returns string
- Defined in init/classes/config.ts:1160
set defaultRank(defaultRank: string): void
Parameters
- defaultRank: string
Returns void
- Defined in init/classes/config.ts:1163

`Static`defaultSeparatorFormatting

get defaultSeparatorFormatting(): string
Returns string
- Defined in init/classes/config.ts:1178
set defaultSeparatorFormatting(defaultSeparatorFormatting: string): void
Parameters
- defaultSeparatorFormatting: string
Returns void
- Defined in init/classes/config.ts:1181

`Static`disableCustomChatMessages

get disableCustomChatMessages(): boolean
Returns boolean
- Defined in init/classes/config.ts:1184
set disableCustomChatMessages(disableCustomChatMessages: boolean): void
Parameters
- disableCustomChatMessages: boolean
Returns void
- Defined in init/classes/config.ts:1187

`Static`messageTemplateString

get messageTemplateString(): string
Returns string
- Defined in init/classes/config.ts:1135
set messageTemplateString(messageTemplateString: string): void
Parameters
- messageTemplateString: string
Returns void
- Defined in init/classes/config.ts:1141

`Static`nameDisplayPrefix

get nameDisplayPrefix(): string
Returns string
- Defined in init/classes/config.ts:1085
set nameDisplayPrefix(nameDisplayPrefix: string): void
Parameters
- nameDisplayPrefix: string
Returns void
- Defined in init/classes/config.ts:1088

`Static`nameDisplaySuffix

get nameDisplaySuffix(): string
Returns string
- Defined in init/classes/config.ts:1091
set nameDisplaySuffix(nameDisplaySuffix: string): void
Parameters
- nameDisplaySuffix: string
Returns void
- Defined in init/classes/config.ts:1094

`Static`nameTagTemplateString

get nameTagTemplateString(): string
Returns string
- Defined in init/classes/config.ts:1148
set nameTagTemplateString(nameTagTemplateString: string): void
Parameters
- nameTagTemplateString: string
Returns void
- Defined in init/classes/config.ts:1154

`Static`playerNameTagHealthPrecision

get playerNameTagHealthPrecision(): | 0
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20
The maximum number of decimal places to display on the health display on player name tags.

Must be between 0 and 20 (inclusive).

Dynamic Property ID: andexdbSettings:playerNameTagHealthPrecision

Returns
    | 0
    | 1
    | 2
    | 3
    | 4
    | 5
    | 6
    | 7
    | 8
    | 9
    | 10
    | 11
    | 12
    | 13
    | 14
    | 15
    | 16
    | 17
    | 18
    | 19
    | 20
Default
```
1
```
- Defined in init/classes/config.ts:1049
set playerNameTagHealthPrecision(playerNameTagHealthPrecision: number): void
Parameters
- playerNameTagHealthPrecision: number
Returns void
- Defined in init/classes/config.ts:1052

`Static`rankDisplayPrefix

get rankDisplayPrefix(): string
Returns string
- Defined in init/classes/config.ts:1073
set rankDisplayPrefix(rankDisplayPrefix: string): void
Parameters
- rankDisplayPrefix: string
Returns void
- Defined in init/classes/config.ts:1076

`Static`rankDisplaySeparator

get rankDisplaySeparator(): string
Returns string
- Defined in init/classes/config.ts:1103
set rankDisplaySeparator(rankDisplaySeparator: string): void
Parameters
- rankDisplaySeparator: string
Returns void
- Defined in init/classes/config.ts:1106

`Static`rankDisplaySuffix

get rankDisplaySuffix(): string
Returns string
- Defined in init/classes/config.ts:1079
set rankDisplaySuffix(rankDisplaySuffix: string): void
Parameters
- rankDisplaySuffix: string
Returns void
- Defined in init/classes/config.ts:1082

`Static`rankEvaluatorMode_chat

get rankEvaluatorMode_chat(): "default" | "suffix_and_prefix_only_once"
Returns "default" | "suffix_and_prefix_only_once"
- Defined in init/classes/config.ts:1061
set rankEvaluatorMode_chat(
rankEvaluatorMode_chat: "default" | "suffix_and_prefix_only_once",
): void
Parameters
- rankEvaluatorMode_chat: "default" | "suffix_and_prefix_only_once"
Returns void
- Defined in init/classes/config.ts:1064

`Static`rankEvaluatorMode_nameTags

get rankEvaluatorMode_nameTags(): "default" | "suffix_and_prefix_only_once"
Returns "default" | "suffix_and_prefix_only_once"
- Defined in init/classes/config.ts:1067
set rankEvaluatorMode_nameTags(
rankEvaluatorMode_nameTags: "default" | "suffix_and_prefix_only_once",
): void
Parameters
- rankEvaluatorMode_nameTags: "default" | "suffix_and_prefix_only_once"
Returns void
- Defined in init/classes/config.ts:1070

`Static`rankMode

get rankMode(): | "custom_simple"
| "custom_advanced"
| "style_1"
| "style_2"
| "style_3"
| "style_4"
| "style_5"
Returns
    | "custom_simple"
    | "custom_advanced"
    | "style_1"
    | "style_2"
    | "style_3"
    | "style_4"
    | "style_5"
- Defined in init/classes/config.ts:1055
set rankMode(
    rankMode:
        | "custom_simple"
        | "custom_advanced"
        | "style_1"
        | "style_2"
        | "style_3"
        | "style_4"
        | "style_5",
): void
Parameters
- rankMode:
      | "custom_simple"
      | "custom_advanced"
      | "style_1"
      | "style_2"
      | "style_3"
      | "style_4"
      | "style_5"
Returns void
- Defined in init/classes/config.ts:1058

`Static`rankTemplateString

get rankTemplateString(): string
The template string for individual ranks.

Returns string
Default
```
"[${rank}§r]"
```
- Defined in init/classes/config.ts:1129
set rankTemplateString(rankTemplateString: string): void
Parameters
- rankTemplateString: string
Returns void
- Defined in init/classes/config.ts:1132

`Static`showHealthOnPlayerNameTags

get showHealthOnPlayerNameTags(): boolean
Returns boolean
- Defined in init/classes/config.ts:1034
set showHealthOnPlayerNameTags(showHealthOnPlayerNameTags: boolean): void
Parameters
- showHealthOnPlayerNameTags: boolean
Returns void
- Defined in init/classes/config.ts:1037

`Static`showRanksOnPlayerNameTags

get showRanksOnPlayerNameTags(): boolean
Returns boolean
- Defined in init/classes/config.ts:1028
set showRanksOnPlayerNameTags(showRanksOnPlayerNameTags: boolean): void
Parameters
- showRanksOnPlayerNameTags: boolean
Returns void
- Defined in init/classes/config.ts:1031

Class chatRanks

Index

Accessors

Accessors

StaticallowChatEscapeCodes

Returns boolean

Parameters

Returns void

StaticallowCustomChatMessagesMuting

Returns boolean

Parameters

Returns void

StaticautoEscapeChatMessages

Returns boolean

Parameters

Returns void

StaticautoURIEscapeChatMessages

Returns boolean

Parameters

Returns void

StaticchatDimensionTemplateString

Returns string

Todo

Default

Parameters

Returns void

StaticchatDisplayTimeStamp

Returns boolean

Parameters

Returns void

StaticchatNameAndMessageSeparator

Returns string

Parameters

Returns void

StaticchatRankPrefix

Returns string

Parameters

Returns void

StaticchatSudoPrefix

Returns string

Parameters

Returns void

StaticdefaultMessageFormatting

Returns string

Parameters

Returns void

StaticdefaultNameFormatting

Returns string

Parameters

Returns void

StaticdefaultRank

Returns string

Parameters

Returns void

StaticdefaultSeparatorFormatting

Returns string

Parameters

Returns void

StaticdisableCustomChatMessages

Returns boolean

Parameters

Returns void

StaticmessageTemplateString

Returns string

Parameters

Returns void

StaticnameDisplayPrefix

Returns string

Parameters

Returns void

StaticnameDisplaySuffix

Returns string

Parameters

Returns void

StaticnameTagTemplateString

Returns string

Parameters

Returns void

StaticplayerNameTagHealthPrecision

Returns | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20

`Static`allowChatEscapeCodes

`Static`allowCustomChatMessagesMuting

`Static`autoEscapeChatMessages

`Static`autoURIEscapeChatMessages

`Static`chatDimensionTemplateString

`Static`chatDisplayTimeStamp

`Static`chatNameAndMessageSeparator

`Static`chatRankPrefix

`Static`chatSudoPrefix

`Static`defaultMessageFormatting

`Static`defaultNameFormatting

`Static`defaultRank

`Static`defaultSeparatorFormatting

`Static`disableCustomChatMessages

`Static`messageTemplateString

`Static`nameDisplayPrefix

`Static`nameDisplaySuffix

`Static`nameTagTemplateString

`Static`playerNameTagHealthPrecision

Returns
| 0
| 1
| 2
| 3
| 4
| 5
| 6
| 7
| 8
| 9
| 10
| 11
| 12
| 13
| 14
| 15
| 16
| 17
| 18
| 19
| 20

`Static`rankDisplayPrefix

`Static`rankDisplaySeparator

`Static`rankDisplaySuffix

`Static`rankEvaluatorMode_chat

`Static`rankEvaluatorMode_nameTags

`Static`rankMode

Returns
| "custom_simple"
| "custom_advanced"
| "style_1"
| "style_2"
| "style_3"
| "style_4"
| "style_5"

`Static`rankTemplateString

`Static`showHealthOnPlayerNameTags

`Static`showRanksOnPlayerNameTags