Function chatRanksSettings_generalChatSettings

chatRanksSettings_generalChatSettings(
sourceEntity: loosePlayerType,
): Promise<0 | 1>
Displays and handles the general chat settings form for a given player or entity.
Parameters
- sourceEntity: loosePlayerType
  The player viewing the UI.
Returns Promise<0 | 1>
A promise that resolves to 0 if the previous menu should be closed, or 1 if the previous menu should be reopened.
Async
Throws
If sourceEntity is not an instance of the Player class or an instance of the executeCommandPlayerW class with a Player linked to it.

The form allows the user to configure various chat rank settings such as:
- Rank style/mode
- Rank display prefix and suffix
- Name display prefix and suffix
- Chat name and message separator
- Rank display separator
- Rank template string
- Message template string
- Default rank template string for players with no rank
- Default message formatting
- Default name formatting
- Default separator formatting
- Disabling custom chat messages
- Allowing custom chat messages muting
- Auto escaping chat messages
- Auto URI escaping chat messages
- Allowing chat escape codes
- Displaying timestamps in chat
- Showing ranks on player name tags
If ultraSecurityModeEnabled is true, the function checks if the player has the required permission to access the settings. If not, an access denied message is shown.
- Defined in modules/ui/functions/chatRanksSettings_generalChatSettings.ts:43