OpenTTD Source  20241108-master-g80f628063a
strings_type.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #ifndef STRINGS_TYPE_H
11 #define STRINGS_TYPE_H
12 
16 typedef uint32_t StringID;
17 static const StringID INVALID_STRING_ID = 0xFFFF;
18 static const int MAX_CHAR_LENGTH = 4;
19 static const uint MAX_LANG = 0x7F;
20 
25 };
26 
28 enum StringTab {
29  /* Tabs 0..1 for regular strings */
30  TEXT_TAB_TOWN = 4,
31  TEXT_TAB_INDUSTRY = 9,
32  TEXT_TAB_STATION = 12,
33  TEXT_TAB_SPECIAL = 14,
34  TEXT_TAB_OLD_CUSTOM = 15,
35  TEXT_TAB_VEHICLE = 16,
36  /* Tab 17 for regular strings */
37  TEXT_TAB_OLD_NEWGRF = 26,
38  TEXT_TAB_END = 32,
41 };
42 
44 static const uint TAB_SIZE_BITS = 11;
46 static const uint TAB_SIZE = 1 << TAB_SIZE_BITS;
47 
49 static const uint TAB_SIZE_GAMESCRIPT = TAB_SIZE * 32;
50 
52 static const uint TAB_SIZE_NEWGRF = TAB_SIZE * 256;
53 
56 
57  /* special strings for town names. the town name is generated dynamically on request. */
58  SPECSTR_TOWNNAME_START = 0x20C0,
59  SPECSTR_TOWNNAME_ENGLISH = SPECSTR_TOWNNAME_START,
60  SPECSTR_TOWNNAME_FRENCH,
61  SPECSTR_TOWNNAME_GERMAN,
62  SPECSTR_TOWNNAME_AMERICAN,
63  SPECSTR_TOWNNAME_LATIN,
64  SPECSTR_TOWNNAME_SILLY,
65  SPECSTR_TOWNNAME_SWEDISH,
66  SPECSTR_TOWNNAME_DUTCH,
67  SPECSTR_TOWNNAME_FINNISH,
68  SPECSTR_TOWNNAME_POLISH,
69  SPECSTR_TOWNNAME_SLOVAK,
70  SPECSTR_TOWNNAME_NORWEGIAN,
71  SPECSTR_TOWNNAME_HUNGARIAN,
72  SPECSTR_TOWNNAME_AUSTRIAN,
73  SPECSTR_TOWNNAME_ROMANIAN,
74  SPECSTR_TOWNNAME_CZECH,
75  SPECSTR_TOWNNAME_SWISS,
76  SPECSTR_TOWNNAME_DANISH,
77  SPECSTR_TOWNNAME_TURKISH,
78  SPECSTR_TOWNNAME_ITALIAN,
79  SPECSTR_TOWNNAME_CATALAN,
80  SPECSTR_TOWNNAME_LAST = SPECSTR_TOWNNAME_CATALAN,
81 
82  /* special strings for company names on the form "TownName transport". */
83  SPECSTR_COMPANY_NAME_START = 0x70EA,
84  SPECSTR_COMPANY_NAME_LAST = SPECSTR_COMPANY_NAME_START + SPECSTR_TOWNNAME_LAST - SPECSTR_TOWNNAME_START,
85 
86  SPECSTR_SILLY_NAME = 0x70E5,
87  SPECSTR_ANDCO_NAME = 0x70E6,
88  SPECSTR_PRESIDENT_NAME = 0x70E7,
89 };
90 
91 using StringParameterData = std::variant<uint64_t, std::string>;
92 
93 #endif /* STRINGS_TYPE_H */
TextDirection
Directions a text can go to.
Definition: strings_type.h:22
@ TD_LTR
Text is written left-to-right by default.
Definition: strings_type.h:23
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
static const uint TAB_SIZE_NEWGRF
Number of strings for NewGRFs.
Definition: strings_type.h:52
static const uint TAB_SIZE_GAMESCRIPT
Number of strings for GameScripts.
Definition: strings_type.h:49
static const uint MAX_LANG
Maximum number of languages supported by the game, and the NewGRF specs.
Definition: strings_type.h:19
static const uint TAB_SIZE_BITS
Number of bits for the StringIndex within a StringTab.
Definition: strings_type.h:44
static const uint TAB_SIZE
Number of strings per StringTab.
Definition: strings_type.h:46
SpecialStrings
Special string constants.
Definition: strings_type.h:55
StringTab
StringTabs to group StringIDs.
Definition: strings_type.h:28
@ TEXT_TAB_NEWGRF_START
Start of NewGRF supplied strings.
Definition: strings_type.h:40
@ TEXT_TAB_GAMESCRIPT_START
Start of GameScript supplied strings.
Definition: strings_type.h:39
@ TEXT_TAB_END
End of language files.
Definition: strings_type.h:38
static const int MAX_CHAR_LENGTH
Max. length of UTF-8 encoded unicode character.
Definition: strings_type.h:18