Component Formats

These options define string formats used in other format strings, or for purposes other than speech bubbles and chat messages.

FormatAliases

Default: @(shout:shout;quiet:low)

Specifies aliases for streams, in the form alias:stream. These will be usable in chat as /alias and will behave equivalently to the regular command. The normal command will also still be available.

This must return an at-map, or it will be ignored.

FormatAdminIcon

Default: Item_Sledgehamer [sic]

The format used to determine the value of $adminIcon in the FormatIcon format. This format expects a valid texture name. /iconinfo command can be used to determine an icon name for this format.

Tokens:

• $username

FormatCard

Default: draws $card

The format used for local /card overhead message content.

Tokens:

• $card: The card that was drawn, in English.
• $number: The number of the card, from 1 to 13. 1 is ace, 11 is jack, 12 is queen, and 13 is king.
• $suit: The suit of the card, from 1 to 4. 1 is clubs, 2 is diamonds, 3 is hearts, and 4 is spades.

FormatChatPrefix

Default: $if($icon $icon <SPACE>)$if($neq($stream server) $timestamp)$tag$language$if($buffyCrit $buffyCrit ( <SPACE>))
Token Context: Processed Chat

The format used to determine the value of the $prefix token in ChatFormatFull.

FormatFlip

Default: flips a coin and gets @($heads:heads;tails)

The format used for local /roll overhead message content.

Tokens:

• $heads: Populated if the result of the coin flip was heads.

FormatIcon

Default: @($eq($stream card):Item_CardDeck;$any($buffyRoll $eq($stream roll)):Item_Dice;$has(@(say;shout;whisper;faction;safehouse;ooc;general) $stream):@($adminIcon;$icon))

The format used to determine the value of $icon in other formats.

Tokens:

• $adminIcon: The icon determined by FormatAdminIcon. This is only populated when the player is an admin with the relevant option enabled.
• $buffyRoll
• $chatType
• $icon: The icon associated with the message, or set with /seticon.
• $stream

FormatInfo

(blank by default)

Information that can be accessed by clicking an info button on the chat. If blank, the info button will not be visible.

Tokens:

• $forename
• $name
• $surname
• $username

FormatLanguage

Default: $if($all($language $not($unknownLanguage)) [$language]( <SPACE> ))

The format used for displaying the roleplay language in which a message was sent. The default format will display as [Language].

This controls the value of $language in ChatFormatFull.

Tokens:

• $chatType
• $language
• $languageRaw
• $stream
• $unknownLanguage

FormatMenuName

Default: $ifelse($neq($menuType mini_scoreboard) $name $username  [ $name ])

The format used for displaying character names within in-game menus such as the trading window, medical check, and the admin mini-scoreboard. If blank, menus will not be affected.

Tokens:

• $forename
• $name: The character name without name colors applied.
• $surname
• $username
• $menuType: The type of menu in which the name will appear. One of:
  • medical
  • mini_scoreboard
  • search_player (see EnableCompatSearchPlayers)
  • trade
  • typing (see PredicateShowTypingIndicator)

FormatName

Default: $ifelse($has(@(general;admin;whisper) $chatType) $username @($name;$forename))

The format used to determine the values of $name and $nameRaw in other format strings.

Tokens:

• $chatType
• $forename
• $name: The name that was set with /name, if specified.
• $surname
• $username

FormatNarrativeDialogueTag

Default: @($eq($stream shout):shouts;$eq($stream whisper):whispers;$endswith($input ?):asks;$endswith($input !):exclaims;$endswith($input ..):says;$lt($len($input) 10):states;says)

The format used to determine the dialogue tag used in narrative style.

Tokens:

• $callout
• $chatType
• $input
• $name
• $sneakCallout
• $stream
• $username

FormatNarrativePunctuation

Default: $unless($sneakCallout @($eq($stream shout):!;.))

The format used to determine the punctuation used in narrative style if the input doesn't end with punctuation.

Tokens:

• $callout
• $chatType
• $dialogueTag
• $input
• $name
• $sneakCallout
• $stream
• $username

FormatTyping

Default: $fmttyping($names $alt)

The format used to determine the text used for typing indicators.

Tokens:

• $alt: Populated when requesting an alternative, shorter string. This is used when the content of the regular string was too long to fit the chat box.
• $names: An at-map containing the names of the people typing. Not populated when requesting an alternative string.

FormatOverheadPrefix

Default: $concats(( ) $index(@(low:[Low];whisper:[Whisper]) $stream) $if($languageRaw [$languageRaw])) 

The format used to determine the value of the $prefix token in OverheadFormatFull.

Tokens::

• $callout
• $chatType
• $input
• $language
• $languageRaw
• $name
• $sneakCallout
• $stream
• $username

FormatRoll

Default: rolls $roll on a $sides-sided die

The format used for local /roll overhead message content.

Tokens:

• $roll: The number that was rolled.
• $sides: The number of sides on the die that was rolled.

FormatTag

Default: [$tag]

The format used when Enable tags is selected in the chat settings menu. This describes the chat title that displays to the left of messages (e.g., [Local]).

Tokens:

• $chatType
• $stream
• $tag: The title of the chat type associated with the message.

FormatTimestamp

Default: [$ifelse($eq($hourFormat 12) $h $HH):$mm]

The format used when Enable timestamps is selected in the chat settings menu.

Tokens:

• $ampm: am or pm, based on the hour a message was sent.
• $AMPM: AM or PM, based on the hour a message was sent.
• $chatType
• $H: The hour the message was sent, in 24-hour format.
• $HH: The zero-padded hour the message was sent, in 24-hour format.
• $h: The hour the message was sent, in 12-hour format.
• $hh: The zero-padded hour the message was sent, in 12-hour format.
• $m: The minute the message was sent.
• $mm: The zero-padded minute the message was sent.
• $P: The hour the message was sent, in the hour format the player prefers.
• $PP: The zero-padded hour the message was sent, in the hour format the player prefers.
• $hourFormat: 12 if the user prefers 12-hour clock formats; otherwise, 24.
• $s: The second the message was sent.
• $ss: The zero-padded second the message was sent.
• $stream