1

/* $Id$ */

     2

     3

/** @file town.h */

     4

     5

#ifndef TOWN_H

     6

#define TOWN_H

     7

     8

#include "oldpool.h"

     9

#include "core/random_func.hpp"

    10

#include "cargo_type.h"

    11

#include "tile_type.h"

    12

#include "date_type.h"

    13

#include "town_type.h"

    14

#include "player_type.h"

    15

#include "newgrf_string_type.h"

    16

    17

enum {

    18

	HOUSE_NO_CLASS   = 0,

    19

	NEW_HOUSE_OFFSET = 110,

    20

	HOUSE_MAX        = 512,

    21

	INVALID_TOWN     = 0xFFFF,

    22

	INVALID_HOUSE_ID = 0xFFFF,

    23

    24

	/* There can only be as many classes as there are new houses, plus one for

    25

	 * NO_CLASS, as the original houses don't have classes. */

    26

	HOUSE_CLASS_MAX  = HOUSE_MAX - NEW_HOUSE_OFFSET + 1,

    27

};

    28

    29

enum BuildingFlags {

    30

	TILE_NO_FLAG         =       0,

    31

	TILE_SIZE_1x1        = 1U << 0,

    32

	TILE_NOT_SLOPED      = 1U << 1,

    33

	TILE_SIZE_2x1        = 1U << 2,

    34

	TILE_SIZE_1x2        = 1U << 3,

    35

	TILE_SIZE_2x2        = 1U << 4,

    36

	BUILDING_IS_ANIMATED = 1U << 5,

    37

	BUILDING_IS_CHURCH   = 1U << 6,

    38

	BUILDING_IS_STADIUM  = 1U << 7,

    39

	BUILDING_HAS_1_TILE  = TILE_SIZE_1x1 | TILE_SIZE_2x1 | TILE_SIZE_1x2 | TILE_SIZE_2x2,

    40

	BUILDING_2_TILES_X   = TILE_SIZE_2x1 | TILE_SIZE_2x2,

    41

	BUILDING_2_TILES_Y   = TILE_SIZE_1x2 | TILE_SIZE_2x2,

    42

	BUILDING_HAS_4_TILES = TILE_SIZE_2x2,

    43

};

    44

    45

DECLARE_ENUM_AS_BIT_SET(BuildingFlags)

    46

    47

enum HouseZonesBits {

    48

	HZB_TOWN_EDGE = 0,

    49

	HZB_TOWN_OUTSKIRT,

    50

	HZB_TOWN_OUTER_SUBURB,

    51

	HZB_TOWN_INNER_SUBURB,

    52

	HZB_TOWN_CENTRE,

    53

};

    54

    55

enum HouseZones {                  ///< Bit  Value       Meaning

    56

	HZ_NOZNS             = 0x0000,  ///<       0          This is just to get rid of zeros, meaning none

    57

	HZ_ZON1              = 1U << HZB_TOWN_EDGE,    ///< 0..4 1,2,4,8,10  which town zones the building can be built in, Zone1 been the further suburb

    58

	HZ_ZON2              = 1U << HZB_TOWN_OUTSKIRT,

    59

	HZ_ZON3              = 1U << HZB_TOWN_OUTER_SUBURB,

    60

	HZ_ZON4              = 1U << HZB_TOWN_INNER_SUBURB,

    61

	HZ_ZON5              = 1U << HZB_TOWN_CENTRE,  ///<  center of town

    62

	HZ_ZONALL            = 0x001F,  ///<       1F         This is just to englobe all above types at once

    63

	HZ_SUBARTC_ABOVE     = 0x0800,  ///< 11    800        can appear in sub-arctic climate above the snow line

    64

	HZ_TEMP              = 0x1000,  ///< 12   1000        can appear in temperate climate

    65

	HZ_SUBARTC_BELOW     = 0x2000,  ///< 13   2000        can appear in sub-arctic climate below the snow line

    66

	HZ_SUBTROPIC         = 0x4000,  ///< 14   4000        can appear in subtropical climate

    67

	HZ_TOYLND            = 0x8000   ///< 15   8000        can appear in toyland climate

    68

};

    69

    70

DECLARE_ENUM_AS_BIT_SET(HouseZones)

    71

    72

enum HouseExtraFlags {

    73

	NO_EXTRA_FLAG            =       0,

    74

	BUILDING_IS_HISTORICAL   = 1U << 0,  ///< this house will only appear during town generation in random games, thus the historical

    75

	BUILDING_IS_PROTECTED    = 1U << 1,  ///< towns and AI will not remove this house, while human players will be able tp

    76

	SYNCHRONISED_CALLBACK_1B = 1U << 2,  ///< synchronized callback 1B will be performed, on multi tile houses

    77

	CALLBACK_1A_RANDOM_BITS  = 1U << 3,  ///< callback 1A needs random bits

    78

};

    79

    80

DECLARE_ENUM_AS_BIT_SET(HouseExtraFlags)

    81

    82

struct BuildingCounts {

    83

	uint8 id_count[HOUSE_MAX];

    84

	uint8 class_count[HOUSE_CLASS_MAX];

    85

};

    86

    87

DECLARE_OLD_POOL(Town, Town, 3, 8000)

    88

    89

struct Town : PoolItem<Town, TownID, &_Town_pool> {

    90

	TileIndex xy;

    91

    92

	/* Current population of people and amount of houses. */

    93

	uint32 num_houses;

    94

	uint32 population;

    95

    96

	/* Town name */

    97

	uint32 townnamegrfid;

    98

	uint16 townnametype;

    99

	uint32 townnameparts;

   100

	char *name;

   101

   102

	/* NOSAVE: Location of name sign, UpdateTownVirtCoord updates this. */

   103

	ViewportSign sign;

   104

   105

	/* Makes sure we don't build certain house types twice.

   106

	 * bit 0 = Building funds received

   107

	 * bit 1 = CHURCH

   108

	 * bit 2 = STADIUM */

   109

	byte flags12;

   110

   111

	/* Which players have a statue? */

   112

	byte statues;

   113

   114

	/* Player ratings as well as a mask that determines which players have a rating. */

   115

	byte have_ratings;

   116

	uint8 unwanted[MAX_PLAYERS]; ///< how many months companies aren't wanted by towns (bribe)

   117

	PlayerByte exclusivity;      ///< which player has exslusivity

   118

	uint8 exclusive_counter;     ///< months till the exclusivity expires

   119

	int16 ratings[MAX_PLAYERS];

   120

	int16 test_rating;

   121

   122

	/* Maximum amount of passengers and mail that can be transported. */

   123

	uint32 max_pass;

   124

	uint32 max_mail;

   125

	uint32 new_max_pass;

   126

	uint32 new_max_mail;

   127

	uint32 act_pass;

   128

	uint32 act_mail;

   129

	uint32 new_act_pass;

   130

	uint32 new_act_mail;

   131

   132

	/* Amount of passengers that were transported. */

   133

	byte pct_pass_transported;

   134

	byte pct_mail_transported;

   135

   136

	/* Amount of food and paper that was transported. Actually a bit mask would be enough. */

   137

	uint16 act_food;

   138

	uint16 act_water;

   139

	uint16 new_act_food;

   140

	uint16 new_act_water;

   141

   142

	/* Time until we rebuild a house. */

   143

	uint16 time_until_rebuild;

   144

   145

	/* When to grow town next time. */

   146

	uint16 grow_counter;

   147

	int16 growth_rate;

   148

   149

	/* Fund buildings program in action? */

   150

	byte fund_buildings_months;

   151

   152

	/* Fund road reconstruction in action? */

   153

	byte road_build_months;

   154

   155

	/* If this is a larger town, and should grow more quickly. */

   156

	bool larger_town;

   157

   158

	/* NOSAVE: UpdateTownRadius updates this given the house count. */

   159

	uint16 radius[5];

   160

   161

	/* NOSAVE: The number of each type of building in the town. */

   162

	BuildingCounts building_counts;

   163

   164

	/**

   165

	 * Creates a new town

   166

	 */

   167

	Town(TileIndex tile = 0);

   168

   169

	/** Destroy the town */

   170

	~Town();

   171

   172

	inline bool IsValid() const { return this->xy != 0; }

   173

};

   174

   175

struct HouseSpec {

   176

	/* Standard properties */

   177

	Year min_date;                     ///< introduction year of the house

   178

	Year max_date;                     ///< last year it can be built

   179

	byte population;                   ///< population (Zero on other tiles in multi tile house.)

   180

	byte removal_cost;                 ///< cost multiplier for removing it

   181

	GRFMappedStringID building_name;   ///< building name

   182

	uint16 remove_rating_decrease;     ///< rating decrease if removed

   183

	byte mail_generation;              ///< mail generation multiplier (tile based, as the acceptances below)

   184

	byte cargo_acceptance[3];          ///< acceptance level for the cargo slots

   185

	CargoID accepts_cargo[3];          ///< 3 input cargo slots

   186

	BuildingFlags building_flags;      ///< some flags that describe the house (size, stadium etc...)

   187

	HouseZones building_availability;  ///< where can it be built (climates, zones)

   188

	bool enabled;                      ///< the house is available to build (true by default, but can be disabled by newgrf)

   189

   190

	/* NewHouses properties */

   191

	HouseID substitute_id;             ///< which original house this one is based on

   192

	struct SpriteGroup *spritegroup;   ///< pointer to the different sprites of the house

   193

	HouseID override;                  ///< which house this one replaces

   194

	uint16 callback_mask;              ///< House callback flags

   195

	byte random_colour[4];             ///< 4 "random" colours

   196

	byte probability;                  ///< Relative probability of appearing (16 is the standard value)

   197

	HouseExtraFlags extra_flags;       ///< some more flags

   198

	HouseClassID class_id;             ///< defines the class this house has (grf file based) @See HouseGetVariable, prop 0x44

   199

	byte animation_frames;             ///< number of animation frames

   200

	byte animation_speed;              ///< amount of time between each of those frames

   201

	byte processing_time;              ///< Periodic refresh multiplier

   202

	byte minimum_life;                 ///< The minimum number of years this house will survive before the town rebuilds it

   203

   204

	/* grf file related properties*/

   205

	uint8 local_id;                    ///< id defined by the grf file for this house

   206

	const struct GRFFile *grffile;     ///< grf file that introduced this house

   207

};

   208

   209

extern HouseSpec _house_specs[HOUSE_MAX];

   210

   211

uint32 GetWorldPopulation();

   212

   213

void UpdateTownVirtCoord(Town *t);

   214

void UpdateAllTownVirtCoords();

   215

void InitializeTown();

   216

void ShowTownViewWindow(TownID town);

   217

void ExpandTown(Town *t);

   218

Town *CreateRandomTown(uint attempts, TownSizeMode mode, uint size);

   219

   220

enum {

   221

	ROAD_REMOVE = 0,

   222

	UNMOVEABLE_REMOVE = 1,

   223

	TUNNELBRIDGE_REMOVE = 1,

   224

	INDUSTRY_REMOVE = 2

   225

};

   226

   227

/** This is the number of ticks between towns being processed for building new

   228

 * houses or roads. This value originally came from the size of the town array

   229

 * in TTD. */

   230

static const byte TOWN_GROWTH_FREQUENCY = 70;

   231

   232

/** Simple value that indicates the house has reached the final stage of

   233

 * construction. */

   234

static const byte TOWN_HOUSE_COMPLETED = 3;

   235

   236

/** This enum is used in conjonction with town->flags12.

   237

 * IT simply states what bit is used for.

   238

 * It is pretty unrealistic (IMHO) to only have one church/stadium

   239

 * per town, NO MATTER the population of it.

   240

 * And there are 5 more bits available on flags12...

   241

 */

   242

enum {

   243

	TOWN_IS_FUNDED      = 0,   ///< Town has received some funds for

   244

	TOWN_HAS_CHURCH     = 1,   ///< There can be only one church by town.

   245

	TOWN_HAS_STADIUM    = 2    ///< There can be only one stadium by town.

   246

};

   247

   248

bool CheckforTownRating(uint32 flags, Town *t, byte type);

   249

   250

static inline HouseSpec *GetHouseSpecs(HouseID house_id)

   251

{

   252

	assert(house_id < HOUSE_MAX);

   253

	return &_house_specs[house_id];

   254

}

   255

   256

/**

   257

 * Check if a TownID is valid.

   258

 * @param index to inquiry in the pool of town

   259

 * @return true if it exists

   260

 */

   261

static inline bool IsValidTownID(TownID index)

   262

{

   263

	return index < GetTownPoolSize() && GetTown(index)->IsValid();

   264

}

   265

   266

static inline TownID GetMaxTownIndex()

   267

{

   268

	/* TODO - This isn't the real content of the function, but

   269

	 *  with the new pool-system this will be replaced with one that

   270

	 *  _really_ returns the highest index. Now it just returns

   271

	 *  the next safe value we are sure about everything is below.

   272

	 */

   273

	return GetTownPoolSize() - 1;

   274

}

   275

   276

static inline uint GetNumTowns()

   277

{

   278

	extern uint _total_towns;

   279

   280

	return _total_towns;

   281

}

   282

   283

/**

   284

 * Return a random valid town.

   285

 */

   286

static inline Town *GetRandomTown()

   287

{

   288

	int num = RandomRange(GetNumTowns());

   289

	TownID index = INVALID_TOWN;

   290

   291

	while (num >= 0) {

   292

		num--;

   293

   294

		index++;

   295

		/* Make sure we have a valid town */

   296

		while (!IsValidTownID(index)) {

   297

			index++;

   298

			assert(index <= GetMaxTownIndex());

   299

		}

   300

	}

   301

   302

	return GetTown(index);

   303

}

   304

   305

Town *CalcClosestTownFromTile(TileIndex tile, uint threshold);

   306

   307

#define FOR_ALL_TOWNS_FROM(t, start) for (t = GetTown(start); t != NULL; t = (t->index + 1U < GetTownPoolSize()) ? GetTown(t->index + 1U) : NULL) if (t->IsValid())

   308

#define FOR_ALL_TOWNS(t) FOR_ALL_TOWNS_FROM(t, 0)

   309

   310

extern bool _town_sort_dirty;

   311

extern byte _town_sort_order;

   312

extern const Town **_town_sort;

   313

   314

extern Town *_cleared_town;

   315

extern int _cleared_town_rating;

   316

   317

uint OriginalTileRandomiser(uint x, uint y);

   318

void ResetHouses();

   319

   320

void ClearTownHouse(Town *t, TileIndex tile);

   321

void AfterLoadTown();

   322

void UpdateTownMaxPass(Town *t);

   323

void UpdateTownRadius(Town *t);

   324

bool CheckIfAuthorityAllows(TileIndex tile);

   325

Town *ClosestTownFromTile(TileIndex tile, uint threshold);

   326

void ChangeTownRating(Town *t, int add, int max);

   327

HouseZonesBits GetTownRadiusGroup(const Town* t, TileIndex tile);

   328

void SetTownRatingTestMode(bool mode);

   329

   330

#endif /* TOWN_H */