Chat Formats

These options determine the content that displays for chat messages.

ChatFormatAdmin

Default: $name: <SPACE> $message
Token Context: Chat

The format used for /admin messages in chat.

See also: ColorAdmin.

ChatFormatCard

Default: $fmtrp(<SPACE> $name <SPACE> $punctuate($fmtcard($card)) <SPACE>)
Token Context: Chat

The format used for local /card messages in chat. This respects the range and color options of /me.

If blank, /card messages will be global instead of local and related options will be ignored.

Tokens:

  • All tokens in chat context.
  • $card: The translated name of the card that was drawn.

See also:

ChatFormatDiscord

Default: $author: <SPACE> $message
Token Context: Chat

The format used for messages from Discord in chat. Messages from Discord will not apply name colors.

See also: ColorDiscord.

ChatFormatDo

Default: $fmtrp(<SPACE> $punctuate($capitalize($trim($message))) <SPACE>)
Token Context: Chat

The format used for /do messages in chat. If blank, /do messages will be disabled.

Allows players to use /do to narrate events. With the default setting, /do the lights flicker will appear in chat as « The lights flicker. ».

See also:

ChatFormatDoLoud

Default: $fmtrp(<SPACE> $punctuate($capitalize($trim($message))) <SPACE>)
Token Context: Chat

The format used for /doloud (/dl) messages in chat. If blank, /doloud messages will be disabled.

/doloud behaves similarly to /do, but has a larger range.

See also:

ChatFormatDoQuiet

Default: $fmtrp(<SPACE> $punctuate($capitalize($trim($message))) <SPACE>)
Token Context: Chat

The format used for /doquiet (/dq) messages in chat. If blank, /doquiet messages will be disabled.

/doquiet behaves similarly to /do, but has a smaller range.

See also:

ChatFormatEcho

(blank by default)
Token Context: Chat

The format used for /safehouse and /faction messages echoed onto the /say or /low stream. If blank, echoing will not occur.

See also: OverheadFormatEcho

ChatFormatFaction

Default: $name: <SPACE> $message
Token Context: Chat

The format used for /faction messages in chat.

See also: ColorFaction.

ChatFormatFlip

Default: $fmtrp(<SPACE> $name <SPACE> $punctuate($fmtflip($heads)) <SPACE>)
Token Context: Chat

The format used for local /flip messages in chat. This respects the range and color options of /me.

If blank, /flip messages will be global instead of local and related options will be ignored.

Tokens:

  • All tokens in chat context.
  • $heads: Populated if the result of the flip was heads.

ChatFormatFull

Default: $prefix$content
Token Context: Processed Chat

The format used for the final chat message, after all other formats have been applied.

Tokens:

ChatFormatGeneral

Default: $name: <SPACE> $message
Token Context: Chat

The format used for /all messages in chat.

See also: ColorGeneral.

ChatFormatIncomingPrivate

Default: $fmtpmfrom($name 1): <SPACE> $message
Token Context: Chat

The format used for incoming private messages in chat.

See also:

ChatFormatLow

Default: $name: <SPACE> $message
Token Context: Chat

The format used for /low messages in chat.

See also:

ChatFormatMe

Default: $fmtrp(<SPACE> $name <SPACE> $punctuate($trimright($message)) <SPACE>)
Token Context: Chat

The format used for /me messages in chat. If blank, /me messages will be disabled.

/me messages allow players to describe their actions. With the default settings, if a player with a character named “Jane” uses /me smiles it will appear in chat as « Jane smiles. ».

See also:

ChatFormatMeLoud

Default: $fmtrp(<SPACE> $name <SPACE> $punctuate($trimright($message)) <SPACE>)
Token Context: Chat

The format used for /meloud (/ml) messages in chat. If blank, /meloud messages will be disabled.

/meloud behaves similarly to /me, but has a larger range.

See also:

ChatFormatMeQuiet

Default: $fmtrp(<SPACE> $name <SPACE> $punctuate($trimright($message)) <SPACE>)
Token Context: Chat

The format used for /mequiet (/mq) messages in chat. If blank, /mequiet messages will be disabled.

/mequiet behaves similarly to /me, but has a smaller range.

See also:

ChatFormatMeWhisper

(blank by default)
Token Context: Chat

The format used for /mewhisper (/mw) messages in chat. If blank, /mewhisper messages will be disabled.

/mewhisper behaves similarly to /me, but has a smaller range.

ChatFormatOoc

Default: $name: <SPACE> (( $message ))
Token Context: Chat

The format used for /ooc (local out-of-character) messages in chat.

See also:

ChatFormatOutgoingPrivate

Default: $fmtpmto($recipientName 1): <SPACE> $message
Token Context: Chat

The format used for outgoing private messages in chat.

Tokens:

  • All tokens in chat context.
  • $recipient: The username of the recipient of the message.
  • $recipientRaw: The username of the recipient, without name colors.
  • $recipientName: The chat name of the recipient of the message, as determined by FormatName.
  • $recipientNameRaw: The chat name of the recipient, without name colors.

See also:

ChatFormatRadio

Default: $fmtradio($frequency): <SPACE> $message
Token Context: Chat

The format used for radio messages in chat.

Tokens:

  • All tokens in chat context.
  • $customStream: The name of the custom stream the original message was sent over, if any. This has the same values as $stream, but will only be populated with custom streams.
  • $frequency

See also: ColorRadio.

ChatFormatRoll

Default: $fmtrp(<SPACE> $name <SPACE> $punctuate($fmtroll($roll $sides)) <SPACE>)
Token Context: Chat

The format used for local /roll messages in chat. This respects the range and color options of /me.

If blank, /roll messages will be global instead of local and related options will be ignored.

Tokens:

  • All tokens in chat context.
  • $roll: The number that was rolled.
  • $sides: The number of sides on the die that was rolled.

See also:

ChatFormatSafehouse

Default: $name: <SPACE> $message
Token Context: Chat

The format used for /safehouse messages in chat.

See also: ColorSafehouse.

ChatFormatSay

Default: $name$unless($buffyRoll :) <SPACE> $message
Token Context: Chat

The format used for /say messages in chat.

See also: ColorSay.

ChatFormatServer

Default: $message
Token Context: Chat

The format used for server messages in chat.

See also: ColorServer.

ChatFormatUnknownLanguage

Default: $fmtrp(<SPACE> $name <SPACE> $getunknownlanguagestring($languageRaw $stream) <SPACE>)
Token Context: Chat

The format used when a player character does not speak the language of a chat message.

With the default format, this will display as « Name says/shouts/whispers/signs something in Language. ».

ChatFormatUnknownLanguageRadio

Default: $fmtradio($frequency): $fmtrp($getunknownlanguagestring($languageRaw $stream))
Token Context: Chat

The format used when a player character does not speak the language of a chat message sent over the radio.

With the default format, this will display as Radio (100.0 MHz): « Something is said in Language. ».

Tokens:

  • All tokens in chat context.
  • $customStream: The name of the custom stream the original message was sent over, if any. This has the same values as $stream, but will only be populated with custom streams.
  • $frequency

ChatFormatWhisper

Default: $name: <SPACE> $message
Token Context: Chat

The format used for local /whisper messages in chat.

If populated, the vanilla /whisper is changed to /pm, and /whisper is modified to act as local chat with a very short range. If blank, local whisper will be disabled and the vanilla /whisper will not be renamed.

See also:

ChatFormatYell

Default: $name: <SPACE> $message
Token Context: Chat

The format used for /yell messages in chat.

See also: ColorYell.