town_type.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef TOWN_TYPE_H
#define TOWN_TYPE_H
 
#include "core/enum_type.hpp"
 
typedef uint16_t TownID;
struct Town;
 
enum TownSize : uint8_t {
  TSZ_SMALL,  
  TSZ_MEDIUM, 
  TSZ_LARGE,  
  TSZ_RANDOM, 
 
  TSZ_END,    
};
DECLARE_ENUM_AS_ADDABLE(TownSize)
 
enum Ratings {
  /* These refer to the maximums, so Appalling is -1000 to -400
   * MAXIMUM RATINGS BOUNDARIES */
  RATING_MINIMUM     = -1000,
  RATING_APPALLING   =  -400,
  RATING_VERYPOOR    =  -200,
  RATING_POOR        =     0,
  RATING_MEDIOCRE    =   200,
  RATING_GOOD        =   400,
  RATING_VERYGOOD    =   600,
  RATING_EXCELLENT   =   800,
  RATING_OUTSTANDING =  1000,         
 
  RATING_MAXIMUM = RATING_OUTSTANDING,
 
  RATING_INITIAL = 500, 
 
  /* RATINGS AFFECTING NUMBERS */
  RATING_TREE_DOWN_STEP = -35,
  RATING_TREE_MINIMUM   = RATING_MINIMUM,
  RATING_TREE_UP_STEP   = 7,
  RATING_TREE_MAXIMUM   = 220,
 
  RATING_GROWTH_UP_STEP    =   5, 
  RATING_GROWTH_MAXIMUM    = RATING_MEDIOCRE, 
  RATING_STATION_UP_STEP   =  12, 
  RATING_STATION_DOWN_STEP = -15, 
 
  RATING_TUNNEL_BRIDGE_DOWN_STEP = -250, 
  RATING_TUNNEL_BRIDGE_MINIMUM   =    0, 
  RATING_TUNNEL_BRIDGE_NEEDED_LENIENT    =            144, 
  RATING_TUNNEL_BRIDGE_NEEDED_NEUTRAL    =            208, 
  RATING_TUNNEL_BRIDGE_NEEDED_HOSTILE    =            400, 
  RATING_TUNNEL_BRIDGE_NEEDED_PERMISSIVE = RATING_MINIMUM, 
 
  RATING_ROAD_DOWN_STEP_INNER =  -50, 
  RATING_ROAD_DOWN_STEP_EDGE  =  -18, 
  RATING_ROAD_MINIMUM         = -100, 
  RATING_ROAD_NEEDED_LENIENT    =             16, 
  RATING_ROAD_NEEDED_NEUTRAL    =             64, 
  RATING_ROAD_NEEDED_HOSTILE    =            112, 
  RATING_ROAD_NEEDED_PERMISSIVE = RATING_MINIMUM, 
 
  RATING_HOUSE_MINIMUM  = RATING_MINIMUM,
 
  RATING_BRIBE_UP_STEP = 200,
  RATING_BRIBE_MAXIMUM = 800,
  RATING_BRIBE_DOWN_TO = -50        // XXX SHOULD BE SOMETHING LOWER?
};
 
enum TownLayout : uint8_t {
  TL_BEGIN = 0,
  TL_ORIGINAL = 0,     
  TL_BETTER_ROADS,     
  TL_2X2_GRID,         
  TL_3X3_GRID,         
 
  TL_RANDOM,           
 
  NUM_TLS,             
};
DECLARE_ENUM_AS_ADDABLE(TownLayout)
 
 
enum TownFounding : uint8_t {
  TF_BEGIN = 0,     
  TF_FORBIDDEN = 0, 
  TF_ALLOWED,       
  TF_CUSTOM_LAYOUT, 
  TF_END,           
};
 
enum TownCargoGenMode : uint8_t {
  TCGM_BEGIN = 0,
  TCGM_ORIGINAL = 0,  
  TCGM_BITCOUNT,      
  TCGM_END,
};
 
static const uint MAX_LENGTH_TOWN_NAME_CHARS = 32; 
 
template <typename Tstorage>
struct TransportedCargoStat {
  Tstorage old_max;  
  Tstorage new_max;  
  Tstorage old_act;  
  Tstorage new_act;  
 
  TransportedCargoStat() : old_max(0), new_max(0), old_act(0), new_act(0) {}
 
  void NewMonth()
  {
    this->old_max = this->new_max; this->new_max = 0;
    this->old_act = this->new_act; this->new_act = 0;
  }
};
 
#endif /* TOWN_TYPE_H */