OpenTTD Source: src/table/control_codes.h File Reference

OpenTTD Source 15.3

Enumerations
control_codes.h File Reference

Control codes that are embedded in the translation strings. More...

Go to the source code of this file.

## Enumerations
enum | StringControlCode : uint16_t { SCC_RECORD_SEPARATOR = 0x1E , SCC_CONTROL_START = 0xE000 , SCC_CONTROL_END = 0xE1FF , SCC_SPRITE_START = 0xE200 , SCC_SPRITE_END = SCC_SPRITE_START + 0xFF , SCC_ENCODED = SCC_CONTROL_START , SCC_ENCODED_INTERNAL , SCC_ENCODED_NUMERIC , SCC_ENCODED_STRING , SCC_FIRST_FONT , SCC_NORMALFONT = SCC_FIRST_FONT , SCC_TINYFONT , SCC_BIGFONT , SCC_MONOFONT , SCC_LAST_FONT = SCC_MONOFONT , SCC_REVISION , SCC_COMPANY_NUM , SCC_STATION_FEATURES , SCC_INDUSTRY_NAME , SCC_WAYPOINT_NAME , SCC_STATION_NAME , SCC_DEPOT_NAME , SCC_TOWN_NAME , SCC_GROUP_NAME , SCC_VEHICLE_NAME , SCC_SIGN_NAME , SCC_COMPANY_NAME , SCC_PRESIDENT_NAME , SCC_ENGINE_NAME , SCC_CURRENCY_SHORT , SCC_CURRENCY_LONG , SCC_CARGO_LONG , SCC_CARGO_SHORT , SCC_CARGO_TINY , SCC_CARGO_LIST , SCC_POWER , SCC_POWER_TO_WEIGHT , SCC_VOLUME_LONG , SCC_VOLUME_SHORT , SCC_WEIGHT_LONG , SCC_WEIGHT_SHORT , SCC_FORCE , SCC_VELOCITY , SCC_HEIGHT , SCC_UNITS_DAYS_OR_SECONDS , SCC_UNITS_MONTHS_OR_MINUTES , SCC_UNITS_YEARS_OR_PERIODS , SCC_UNITS_YEARS_OR_MINUTES , SCC_DATE_TINY , SCC_DATE_SHORT , SCC_DATE_LONG , SCC_DATE_ISO , SCC_STRING1 , SCC_STRING2 , SCC_STRING3 , SCC_STRING4 , SCC_STRING5 , SCC_STRING6 , SCC_STRING7 , SCC_STRING , SCC_COMMA , SCC_DECIMAL , SCC_NUM , SCC_ZEROFILL_NUM , SCC_HEX , SCC_BYTES , SCC_RAW_STRING_POINTER , SCC_PLURAL_LIST , SCC_GENDER_LIST , SCC_GENDER_INDEX , SCC_ARG_INDEX , SCC_SET_CASE , SCC_SWITCH_CASE , SCC_BLUE , SCC_SILVER , SCC_GOLD , SCC_RED , SCC_PURPLE , SCC_LTBROWN , SCC_ORANGE , SCC_GREEN , SCC_YELLOW , SCC_DKGREEN , SCC_CREAM , SCC_BROWN , SCC_WHITE , SCC_LTBLUE , SCC_GRAY , SCC_DKBLUE , SCC_BLACK , SCC_COLOUR , SCC_PUSH_COLOUR , SCC_POP_COLOUR , SCC_NEWGRF_FIRST , SCC_NEWGRF_PRINT_DWORD_SIGNED = SCC_NEWGRF_FIRST , SCC_NEWGRF_PRINT_WORD_SIGNED , SCC_NEWGRF_PRINT_BYTE_SIGNED , SCC_NEWGRF_PRINT_WORD_UNSIGNED , SCC_NEWGRF_PRINT_DWORD_CURRENCY , SCC_NEWGRF_PRINT_WORD_STRING_ID , SCC_NEWGRF_PRINT_WORD_DATE_LONG , SCC_NEWGRF_PRINT_WORD_DATE_SHORT , SCC_NEWGRF_PRINT_WORD_SPEED , SCC_NEWGRF_PRINT_WORD_VOLUME_LONG , SCC_NEWGRF_PRINT_WORD_WEIGHT_LONG , SCC_NEWGRF_PRINT_WORD_STATION_NAME , SCC_NEWGRF_PRINT_QWORD_CURRENCY , SCC_NEWGRF_PRINT_BYTE_HEX , SCC_NEWGRF_PRINT_WORD_HEX , SCC_NEWGRF_PRINT_DWORD_HEX , SCC_NEWGRF_PRINT_QWORD_HEX , SCC_NEWGRF_PRINT_DWORD_DATE_LONG , SCC_NEWGRF_PRINT_DWORD_DATE_SHORT , SCC_NEWGRF_PRINT_WORD_POWER , SCC_NEWGRF_PRINT_WORD_VOLUME_SHORT , SCC_NEWGRF_PRINT_WORD_WEIGHT_SHORT , SCC_NEWGRF_PRINT_WORD_CARGO_LONG , SCC_NEWGRF_PRINT_WORD_CARGO_SHORT , SCC_NEWGRF_PRINT_WORD_CARGO_TINY , SCC_NEWGRF_PRINT_WORD_CARGO_NAME , SCC_NEWGRF_PRINT_DWORD_FORCE , SCC_NEWGRF_PUSH_WORD , SCC_NEWGRF_DISCARD_WORD , SCC_NEWGRF_ROTATE_TOP_4_WORDS , SCC_NEWGRF_LAST = SCC_NEWGRF_ROTATE_TOP_4_WORDS , SCC_NEWGRF_STRINL , SCC_LESS_THAN = SCC_SPRITE_START + 0x3C , SCC_GREATER_THAN = SCC_SPRITE_START + 0x3E , SCC_TOWN = SCC_SPRITE_START + 0x9B , SCC_CITY = SCC_SPRITE_START + 0x9C , SCC_LEFT_ARROW = SCC_SPRITE_START + 0x9D , SCC_UP_ARROW = SCC_SPRITE_START + 0xA0 , SCC_DOWN_ARROW = SCC_SPRITE_START + 0xAA , SCC_CHECKMARK = SCC_SPRITE_START + 0xAC , SCC_CROSS = SCC_SPRITE_START + 0xAD , SCC_RIGHT_ARROW = SCC_SPRITE_START + 0xAF , SCC_TRAIN = SCC_SPRITE_START + 0xB4 , SCC_LORRY = SCC_SPRITE_START + 0xB5 , SCC_BUS = SCC_SPRITE_START + 0xB6 , SCC_PLANE = SCC_SPRITE_START + 0xB7 , SCC_SHIP = SCC_SPRITE_START + 0xB8 , SCC_SUPERSCRIPT_M1 = SCC_SPRITE_START + 0xB9 , SCC_SMALL_UP_ARROW = SCC_SPRITE_START + 0xBC , SCC_SMALL_DOWN_ARROW = SCC_SPRITE_START + 0xBD }
| List of string control codes used for string formatting, displaying, and by strgen to generate the language files. More...

## Detailed Description

Control codes that are embedded in the translation strings.

Definition in file control_codes.h.

## Enumeration Type Documentation

## ◆ StringControlCode

enum StringControlCode : uint16_t

List of string control codes used for string formatting, displaying, and by strgen to generate the language files.

Enumerator
SCC_ENCODED | Encoded string marker and sub-string parameter.
SCC_ENCODED_INTERNAL | Encoded text from OpenTTD.
SCC_ENCODED_NUMERIC | Encoded numeric parameter.
SCC_ENCODED_STRING | Encoded string parameter.
SCC_NORMALFONT | Switch to normal size font.
SCC_TINYFONT | Switch to small font.
SCC_BIGFONT | Switch to large font.
SCC_MONOFONT | Switch to monospaced font.
SCC_NEWGRF_FIRST | The next variables are part of a NewGRF subsystem for creating text strings. It uses a "stack" of bytes and reads from there.
SCC_NEWGRF_PRINT_DWORD_SIGNED | 7B: Read 4 bytes from the stack
SCC_NEWGRF_PRINT_WORD_SIGNED | 7C: Read 2 bytes from the stack as signed value
SCC_NEWGRF_PRINT_BYTE_SIGNED | 7D: Read 1 byte from the stack as signed value
SCC_NEWGRF_PRINT_WORD_UNSIGNED | 7E: Read 2 bytes from the stack as unsigned value
SCC_NEWGRF_PRINT_DWORD_CURRENCY | 8F: Read 4 bytes from the stack as currency
SCC_NEWGRF_PRINT_WORD_STRING_ID | 81: Read 2 bytes from the stack as String ID
SCC_NEWGRF_PRINT_WORD_DATE_LONG | 82: Read 2 bytes from the stack as base 1920 date
SCC_NEWGRF_PRINT_WORD_DATE_SHORT | 83: Read 2 bytes from the stack as base 1920 date
SCC_NEWGRF_PRINT_WORD_SPEED | 84: Read 2 bytes from the stack as signed speed
SCC_NEWGRF_PRINT_WORD_VOLUME_LONG | 87: Read 2 bytes from the stack as long signed volume
SCC_NEWGRF_PRINT_WORD_WEIGHT_LONG | 9A 0D: Read 2 bytes from the stack as long unsigned weight
SCC_NEWGRF_PRINT_WORD_STATION_NAME | 9A 0C: Read 2 bytes from the stack as station name
SCC_NEWGRF_PRINT_QWORD_CURRENCY | 9A 01: Read 8 bytes from the stack as currency
SCC_NEWGRF_PRINT_BYTE_HEX | 9A 06: Read 1 byte from the stack and print it as hex
SCC_NEWGRF_PRINT_WORD_HEX | 9A 07: Read 2 bytes from the stack and print it as hex
SCC_NEWGRF_PRINT_DWORD_HEX | 9A 08: Read 4 bytes from the stack and print it as hex
SCC_NEWGRF_PRINT_QWORD_HEX | 9A 0B: Read 8 bytes from the stack and print it as hex
SCC_NEWGRF_PRINT_DWORD_DATE_LONG | 9A 16: Read 4 bytes from the stack as base 0 date
SCC_NEWGRF_PRINT_DWORD_DATE_SHORT | 9A 17: Read 4 bytes from the stack as base 0 date
SCC_NEWGRF_PRINT_WORD_POWER | 9A 18: Read 2 bytes from the stack as unsigned power
SCC_NEWGRF_PRINT_WORD_VOLUME_SHORT | 9A 19: Read 2 bytes from the stack as short signed volume
SCC_NEWGRF_PRINT_WORD_WEIGHT_SHORT | 9A 1A: Read 2 bytes from the stack as short unsigned weight
SCC_NEWGRF_PRINT_WORD_CARGO_LONG | 9A 1B: Read 2 + 2 bytes from the stack as cargo type (translated) and unsigned cargo amount
SCC_NEWGRF_PRINT_WORD_CARGO_SHORT | 9A 1C: Read 2 + 2 bytes from the stack as cargo type (translated) and unsigned cargo amount
SCC_NEWGRF_PRINT_WORD_CARGO_TINY | 9A 1D: Read 2 + 2 bytes from the stack as cargo type (translated) and unsigned cargo amount
SCC_NEWGRF_PRINT_WORD_CARGO_NAME | 9A 1E: Read 2 bytes from the stack as cargo name
SCC_NEWGRF_PRINT_DWORD_FORCE | 9A 21: Read 4 bytes from the stack as unsigned force
SCC_NEWGRF_PUSH_WORD | 9A 03: Pushes 2 bytes onto the stack
SCC_NEWGRF_DISCARD_WORD | 85: Discard the next two bytes
SCC_NEWGRF_ROTATE_TOP_4_WORDS | 86: Rotate the top 4 words of the stack (W4 W1 W2 W3)
SCC_NEWGRF_STRINL | Inline another string at the current position, StringID is encoded in the string.

Definition at line 17 of file control_codes.h.