Class chatRanks

The chat and name tags settings.

Accessors

`Static`allowChatEscapeCodes

get allowChatEscapeCodes(): boolean
Returns boolean
- Defined in init/classes/config.ts:1553
set allowChatEscapeCodes(allowChatEscapeCodes: undefined | boolean): void
Parameters
- allowChatEscapeCodes: undefined | boolean
Returns void
- Defined in init/classes/config.ts:1556

`Static`allowCustomChatMessagesMuting

get allowCustomChatMessagesMuting(): boolean
Returns boolean
- Defined in init/classes/config.ts:1535
set allowCustomChatMessagesMuting(
allowCustomChatMessagesMuting: undefined | boolean,
): void
Parameters
- allowCustomChatMessagesMuting: undefined | boolean
Returns void
- Defined in init/classes/config.ts:1538

`Static`autoEscapeChatMessages

get autoEscapeChatMessages(): boolean
Returns boolean
- Defined in init/classes/config.ts:1541
set autoEscapeChatMessages(autoEscapeChatMessages: undefined | boolean): void
Parameters
- autoEscapeChatMessages: undefined | boolean
Returns void
- Defined in init/classes/config.ts:1544

`Static`autoURIEscapeChatMessages

get autoURIEscapeChatMessages(): boolean
Returns boolean
- Defined in init/classes/config.ts:1547
set autoURIEscapeChatMessages(
autoURIEscapeChatMessages: undefined | boolean,
): void
Parameters
- autoURIEscapeChatMessages: undefined | boolean
Returns void
- Defined in init/classes/config.ts:1550

`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:1463
set chatDimensionTemplateString(
chatDimensionTemplateString: undefined | string,
): void
Parameters
- chatDimensionTemplateString: undefined | string
Returns void
- Defined in init/classes/config.ts:1466

`Static`chatDisplayTimeStamp

get chatDisplayTimeStamp(): boolean
Returns boolean
- Defined in init/classes/config.ts:1333
set chatDisplayTimeStamp(chatDisplayTimeStampEnabled: undefined | boolean): void
Parameters
- chatDisplayTimeStampEnabled: undefined | boolean
Returns void
- Defined in init/classes/config.ts:1336

`Static`chatNameAndMessageSeparator

get chatNameAndMessageSeparator(): string
Returns string
- Defined in init/classes/config.ts:1442
set chatNameAndMessageSeparator(
chatNameAndMessageSeparator: undefined | string,
): void
Parameters
- chatNameAndMessageSeparator: undefined | string
Returns void
- Defined in init/classes/config.ts:1445

`Static`chatRankPrefix

get chatRankPrefix(): string
Returns string
- Defined in init/classes/config.ts:1321
set chatRankPrefix(chatRankPrefix: undefined | string): void
Parameters
- chatRankPrefix: undefined | string
Returns void
- Defined in init/classes/config.ts:1324

`Static`chatSudoPrefix

get chatSudoPrefix(): string
Returns string
- Defined in init/classes/config.ts:1327
set chatSudoPrefix(chatSudoPrefix: undefined | string): void
Parameters
- chatSudoPrefix: undefined | string
Returns void
- Defined in init/classes/config.ts:1330

`Static`defaultMessageFormatting

get defaultMessageFormatting(): string
Returns string
- Defined in init/classes/config.ts:1511
set defaultMessageFormatting(defaultMessageFormatting: undefined | string): void
Parameters
- defaultMessageFormatting: undefined | string
Returns void
- Defined in init/classes/config.ts:1514

`Static`defaultNameFormatting

get defaultNameFormatting(): string
Returns string
- Defined in init/classes/config.ts:1517
set defaultNameFormatting(defaultNameFormatting: undefined | string): void
Parameters
- defaultNameFormatting: undefined | string
Returns void
- Defined in init/classes/config.ts:1520

`Static`defaultRank

get defaultRank(): string
Returns string
- Defined in init/classes/config.ts:1505
set defaultRank(defaultRank: undefined | string): void
Parameters
- defaultRank: undefined | string
Returns void
- Defined in init/classes/config.ts:1508

`Static`defaultSeparatorFormatting

get defaultSeparatorFormatting(): string
Returns string
- Defined in init/classes/config.ts:1523
set defaultSeparatorFormatting(
defaultSeparatorFormatting: undefined | string,
): void
Parameters
- defaultSeparatorFormatting: undefined | string
Returns void
- Defined in init/classes/config.ts:1526

`Static`disableCustomChatMessages

get disableCustomChatMessages(): boolean
Returns boolean
- Defined in init/classes/config.ts:1529
set disableCustomChatMessages(
disableCustomChatMessages: undefined | boolean,
): void
Parameters
- disableCustomChatMessages: undefined | boolean
Returns void
- Defined in init/classes/config.ts:1532

`Static`messageTemplateString

get messageTemplateString(): string
Returns string
- Defined in init/classes/config.ts:1480
set messageTemplateString(messageTemplateString: undefined | string): void
Parameters
- messageTemplateString: undefined | string
Returns void
- Defined in init/classes/config.ts:1486

`Static`nameDisplayPrefix

get nameDisplayPrefix(): string
Returns string
- Defined in init/classes/config.ts:1430
set nameDisplayPrefix(nameDisplayPrefix: undefined | string): void
Parameters
- nameDisplayPrefix: undefined | string
Returns void
- Defined in init/classes/config.ts:1433

`Static`nameDisplaySuffix

get nameDisplaySuffix(): string
Returns string
- Defined in init/classes/config.ts:1436
set nameDisplaySuffix(nameDisplaySuffix: undefined | string): void
Parameters
- nameDisplaySuffix: undefined | string
Returns void
- Defined in init/classes/config.ts:1439

`Static`nameTagTemplateString

get nameTagTemplateString(): string
Returns string
- Defined in init/classes/config.ts:1493
set nameTagTemplateString(nameTagTemplateString: undefined | string): void
Parameters
- nameTagTemplateString: undefined | string
Returns void
- Defined in init/classes/config.ts:1499

`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:1360
set playerNameTagHealthPrecision(
playerNameTagHealthPrecision: undefined | number,
): void
Parameters
- playerNameTagHealthPrecision: undefined | number
Returns void
- Defined in init/classes/config.ts:1384

`Static`rankDisplayPrefix

get rankDisplayPrefix(): string
Returns string
- Defined in init/classes/config.ts:1418
set rankDisplayPrefix(rankDisplayPrefix: undefined | string): void
Parameters
- rankDisplayPrefix: undefined | string
Returns void
- Defined in init/classes/config.ts:1421

`Static`rankDisplaySeparator

get rankDisplaySeparator(): string
Returns string
- Defined in init/classes/config.ts:1448
set rankDisplaySeparator(rankDisplaySeparator: undefined | string): void
Parameters
- rankDisplaySeparator: undefined | string
Returns void
- Defined in init/classes/config.ts:1451

`Static`rankDisplaySuffix

get rankDisplaySuffix(): string
Returns string
- Defined in init/classes/config.ts:1424
set rankDisplaySuffix(rankDisplaySuffix: undefined | string): void
Parameters
- rankDisplaySuffix: undefined | string
Returns void
- Defined in init/classes/config.ts:1427

`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:1406
set rankEvaluatorMode_chat(
    rankEvaluatorMode_chat:
        | undefined
        | "default"
        | "suffix_and_prefix_only_once",
): void
Parameters
- rankEvaluatorMode_chat: undefined | "default" | "suffix_and_prefix_only_once"
Returns void
- Defined in init/classes/config.ts:1409

`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:1412
set rankEvaluatorMode_nameTags(
    rankEvaluatorMode_nameTags:
        | undefined
        | "default"
        | "suffix_and_prefix_only_once",
): void
Parameters
- rankEvaluatorMode_nameTags: undefined | "default" | "suffix_and_prefix_only_once"
Returns void
- Defined in init/classes/config.ts:1415

`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:1400
set rankMode(
    rankMode:
        | undefined
        | "custom_simple"
        | "custom_advanced"
        | "style_1"
        | "style_2"
        | "style_3"
        | "style_4"
        | "style_5",
): void
Parameters
- rankMode:
      | undefined
      | "custom_simple"
      | "custom_advanced"
      | "style_1"
      | "style_2"
      | "style_3"
      | "style_4"
      | "style_5"
Returns void
- Defined in init/classes/config.ts:1403

`Static`rankTemplateString

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

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

`Static`showHealthOnPlayerNameTags

get showHealthOnPlayerNameTags(): boolean
Returns boolean
- Defined in init/classes/config.ts:1345
set showHealthOnPlayerNameTags(
showHealthOnPlayerNameTags: undefined | boolean,
): void
Parameters
- showHealthOnPlayerNameTags: undefined | boolean
Returns void
- Defined in init/classes/config.ts:1348

`Static`showRanksOnPlayerNameTags

get showRanksOnPlayerNameTags(): boolean
Returns boolean
- Defined in init/classes/config.ts:1339
set showRanksOnPlayerNameTags(
showRanksOnPlayerNameTags: undefined | boolean,
): void
Parameters
- showRanksOnPlayerNameTags: undefined | boolean
Returns void
- Defined in init/classes/config.ts:1342

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