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 8 /** @file strings_type.h Types related to strings. */ 9 10 #ifndef STRINGS_TYPE_H 11 #define STRINGS_TYPE_H 12 13 /** 14 * Numeric value that represents a string, independent of the selected language. 15 */ 16 typedef uint32 StringID; 17 static const StringID INVALID_STRING_ID = 0xFFFF; ///< Constant representing an invalid string (16bit in case it is used in savegames) 18 static const int MAX_CHAR_LENGTH = 4; ///< Max. length of UTF-8 encoded unicode character 19 static const uint MAX_LANG = 0x7F; ///< Maximum number of languages supported by the game, and the NewGRF specs 20 21 /** Directions a text can go to */ 22 enum TextDirection { 23 TD_LTR, ///< Text is written left-to-right by default 24 TD_RTL, ///< Text is written right-to-left by default 25 }; 26 27 /** StringTabs to group StringIDs */ 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, ///< End of language files. 39 TEXT_TAB_GAMESCRIPT_START = 32, ///< Start of GameScript supplied strings. 40 TEXT_TAB_NEWGRF_START = 64, ///< Start of NewGRF supplied strings. 41 }; 42 43 /** Number of bits for the StringIndex within a StringTab */ 44 static const uint TAB_SIZE_BITS = 11; 45 /** Number of strings per StringTab */ 46 static const uint TAB_SIZE = 1 << TAB_SIZE_BITS; 47 48 /** Number of strings for GameScripts */ 49 static const uint TAB_SIZE_GAMESCRIPT = TAB_SIZE * 32; 50 51 /** Number of strings for NewGRFs */ 52 static const uint TAB_SIZE_NEWGRF = TAB_SIZE * 256; 53 54 /** Special string constants */ 55 enum SpecialStrings { 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 #endif /* STRINGS_TYPE_H */ 92