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