src/strings_type.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file strings_type.h Types related to strings. */
  11
  12 #ifndef STRINGS_TYPE_H
  13 #define STRINGS_TYPE_H
  14
  15 /**
  16  * Numeric value that represents a string, independent of the selected language.
  17  */
  18 typedef uint16 StringID;
  19 static const StringID INVALID_STRING_ID = 0xFFFF; ///< Constant representing an invalid string
  20 static const int MAX_CHAR_LENGTH        = 4;      ///< Max. length of UTF-8 encoded unicode character
  21 static const uint MAX_LANG              = 0x7F;   ///< Maximum number of languages supported by the game, and the NewGRF specs
  22
  23 /** Directions a text can go to */
  24 enum TextDirection {
  25         TD_LTR, ///< Text is written left-to-right by default
  26         TD_RTL, ///< Text is written right-to-left by default
  27 };
  28
  29 /** Special string constants */
  30 enum SpecialStrings {
  31
  32         /* special strings for town names. the town name is generated dynamically on request. */
  33         SPECSTR_TOWNNAME_START     = 0x20C0,
  34         SPECSTR_TOWNNAME_ENGLISH   = SPECSTR_TOWNNAME_START,
  35         SPECSTR_TOWNNAME_FRENCH,
  36         SPECSTR_TOWNNAME_GERMAN,
  37         SPECSTR_TOWNNAME_AMERICAN,
  38         SPECSTR_TOWNNAME_LATIN,
  39         SPECSTR_TOWNNAME_SILLY,
  40         SPECSTR_TOWNNAME_SWEDISH,
  41         SPECSTR_TOWNNAME_DUTCH,
  42         SPECSTR_TOWNNAME_FINNISH,
  43         SPECSTR_TOWNNAME_POLISH,
  44         SPECSTR_TOWNNAME_SLOVAK,
  45         SPECSTR_TOWNNAME_NORWEGIAN,
  46         SPECSTR_TOWNNAME_HUNGARIAN,
  47         SPECSTR_TOWNNAME_AUSTRIAN,
  48         SPECSTR_TOWNNAME_ROMANIAN,
  49         SPECSTR_TOWNNAME_CZECH,
  50         SPECSTR_TOWNNAME_SWISS,
  51         SPECSTR_TOWNNAME_DANISH,
  52         SPECSTR_TOWNNAME_TURKISH,
  53         SPECSTR_TOWNNAME_ITALIAN,
  54         SPECSTR_TOWNNAME_CATALAN,
  55         SPECSTR_TOWNNAME_LAST      = SPECSTR_TOWNNAME_CATALAN,
  56
  57         /* special strings for company names on the form "TownName transport". */
  58         SPECSTR_COMPANY_NAME_START = 0x70EA,
  59         SPECSTR_COMPANY_NAME_LAST  = SPECSTR_COMPANY_NAME_START + SPECSTR_TOWNNAME_LAST - SPECSTR_TOWNNAME_START,
  60
  61         SPECSTR_SILLY_NAME         = 0x70E5,
  62         SPECSTR_ANDCO_NAME         = 0x70E6,
  63         SPECSTR_PRESIDENT_NAME     = 0x70E7,
  64
  65         /* reserve MAX_LANG strings for the *.lng files */
  66         SPECSTR_LANGUAGE_START     = 0x7100,
  67         SPECSTR_LANGUAGE_END       = SPECSTR_LANGUAGE_START + MAX_LANG - 1,
  68
  69         /* reserve 32 strings for various screen resolutions */
  70         SPECSTR_RESOLUTION_START   = SPECSTR_LANGUAGE_END + 1,
  71         SPECSTR_RESOLUTION_END     = SPECSTR_RESOLUTION_START + 0x1F,
  72
  73         /* reserve 32 strings for screenshot formats */
  74         SPECSTR_SCREENSHOT_START   = SPECSTR_RESOLUTION_END + 1,
  75         SPECSTR_SCREENSHOT_END     = SPECSTR_SCREENSHOT_START + 0x1F,
  76 };
  77
  78 #endif /* STRINGS_TYPE_H */