src/townname_type.h

   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 /**
   9  * @file townname_type.h
  10  * Definition of structures used for generating town names.
  11  */
  12
  13 #ifndef TOWNNAME_TYPE_H
  14 #define TOWNNAME_TYPE_H
  15
  16 #include "newgrf_townname.h"
  17 #include "town_type.h"
  18 #include "string_type.h"
  19
  20 typedef std::set<std::string> TownNames;
  21
  22 static constexpr uint BUILTIN_TOWNNAME_GENERATOR_COUNT = SPECSTR_TOWNNAME_LAST - SPECSTR_TOWNNAME_START + 1; ///< Number of built-in town name generators.
  23
  24 /**
  25  * Struct holding parameters used to generate town name.
  26  * Speeds things up a bit because these values are computed only once per name generation.
  27  */
  28 struct TownNameParams {
  29         uint32_t grfid; ///< newgrf ID (0 if not used)
  30         uint16_t type;  ///< town name style
  31
  32         /**
  33          * Initializes this struct from language ID
  34          * @param town_name town name 'language' ID
  35          */
  36         TownNameParams(byte town_name)
  37         {
  38                 bool grf = town_name >= BUILTIN_TOWNNAME_GENERATOR_COUNT;
  39                 this->grfid = grf ? GetGRFTownNameId(town_name - BUILTIN_TOWNNAME_GENERATOR_COUNT) : 0;
  40                 this->type = grf ? GetGRFTownNameType(town_name - BUILTIN_TOWNNAME_GENERATOR_COUNT) : SPECSTR_TOWNNAME_START + town_name;
  41         }
  42
  43         TownNameParams(const Town *t);
  44 };
  45
  46 #endif /* TOWNNAME_TYPE_H */