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
  21 /**
  22  * Struct holding a parameters used to generate town name.
  23  * Speeds things up a bit because these values are computed only once per name generation.
  24  */
  25 struct TownNameParams {
  26         uint32 grfid; ///< newgrf ID (0 if not used)
  27         uint16 type;  ///< town name style
  28
  29         /**
  30          * Initializes this struct from language ID
  31          * @param town_name town name 'language' ID
  32          */
  33         TownNameParams(byte town_name)
  34         {
  35                 extern int _nb_orig_names;
  36                 bool grf = town_name >= _nb_orig_names;
  37                 this->grfid = grf ? GetGRFTownNameId(town_name - _nb_orig_names) : 0;
  38                 this->type = grf ? GetGRFTownNameType(town_name - _nb_orig_names) : SPECSTR_TOWNNAME_START + town_name;
  39         }
  40
  41         TownNameParams(const Town *t);
  42 };
  43
  44 #endif /* TOWNNAME_TYPE_H */