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

    15

enum {

    16

	HOUSE_NO_CLASS   = 0,

    17

	NEW_HOUSE_OFFSET = 110,

    18

	HOUSE_MAX        = 512,

    19

	INVALID_TOWN     = 0xFFFF,

    20

	INVALID_HOUSE_ID = 0xFFFF,

    21

    22

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

    23

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

    24

	HOUSE_CLASS_MAX  = HOUSE_MAX - NEW_HOUSE_OFFSET + 1,

    25

};

    26

    27

enum BuildingFlags {

    28

	TILE_NO_FLAG         =       0,

    29

	TILE_SIZE_1x1        = 1U << 0,

    30

	TILE_NOT_SLOPED      = 1U << 1,

    31

	TILE_SIZE_2x1        = 1U << 2,

    32

	TILE_SIZE_1x2        = 1U << 3,

    33

	TILE_SIZE_2x2        = 1U << 4,

    34

	BUILDING_IS_ANIMATED = 1U << 5,

    35

	BUILDING_IS_CHURCH   = 1U << 6,

    36

	BUILDING_IS_STADIUM  = 1U << 7,

    37

	BUILDING_HAS_1_TILE  = TILE_SIZE_1x1 | TILE_SIZE_2x1 | TILE_SIZE_1x2 | TILE_SIZE_2x2,

    38

	BUILDING_2_TILES_X   = TILE_SIZE_2x1 | TILE_SIZE_2x2,

    39

	BUILDING_2_TILES_Y   = TILE_SIZE_1x2 | TILE_SIZE_2x2,

    40

	BUILDING_HAS_4_TILES = TILE_SIZE_2x2,

    41

};

    42

    43

DECLARE_ENUM_AS_BIT_SET(BuildingFlags)

    44

    45

enum HouseZones {                  ///< Bit  Value       Meaning

    46

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

    47

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

    48

	HZ_ZON2              = 0x0002,

    49

	HZ_ZON3              = 0x0004,

    50

	HZ_ZON4              = 0x0008,

    51

	HZ_ZON5              = 0x0010,  ///<                  center of town

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

};

    59

    60

DECLARE_ENUM_AS_BIT_SET(HouseZones)

    61

    62

enum HouseExtraFlags {

    63

	NO_EXTRA_FLAG            =       0,

    64

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

    65

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

    66

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

    67

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

    68

};

    69

    70

DECLARE_ENUM_AS_BIT_SET(HouseExtraFlags)

    71

    72

struct BuildingCounts {

    73

	uint8 id_count[HOUSE_MAX];

    74

	uint8 class_count[HOUSE_CLASS_MAX];

    75

};

    76

    77

DECLARE_OLD_POOL(Town, Town, 3, 8000)

    78

    79

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

    80

	TileIndex xy;

    81

    82

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

    83

	uint16 num_houses;

    84

	uint32 population;

    85

    86

	/* Town name */

    87

	uint32 townnamegrfid;

    88

	uint16 townnametype;

    89

	uint32 townnameparts;

    90

    91

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

    92

	ViewportSign sign;

    93

    94

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

    95

	 * bit 0 = Building funds received

    96

	 * bit 1 = CHURCH

    97

	 * bit 2 = STADIUM */

    98

	byte flags12;

    99

   100

	/* Which players have a statue? */

   101

	byte statues;

   102

   103

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

   104

	byte have_ratings;

   105

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

   106

	PlayerByte exclusivity;      ///< which player has exslusivity

   107

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

   108

	int16 ratings[MAX_PLAYERS];

   109

	int16 test_rating;

   110

   111

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

   112

	uint32 max_pass;

   113

	uint32 max_mail;

   114

	uint32 new_max_pass;

   115

	uint32 new_max_mail;

   116

	uint32 act_pass;

   117

	uint32 act_mail;

   118

	uint32 new_act_pass;

   119

	uint32 new_act_mail;

   120

   121

	/* Amount of passengers that were transported. */

   122

	byte pct_pass_transported;

   123

	byte pct_mail_transported;

   124

   125

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

   126

	uint16 act_food;

   127

	uint16 act_water;

   128

	uint16 new_act_food;

   129

	uint16 new_act_water;

   130

   131

	/* Time until we rebuild a house. */

   132

	uint16 time_until_rebuild;

   133

   134

	/* When to grow town next time. */

   135

	uint16 grow_counter;

   136

	int16 growth_rate;

   137

   138

	/* Fund buildings program in action? */

   139

	byte fund_buildings_months;

   140

   141

	/* Fund road reconstruction in action? */

   142

	byte road_build_months;

   143

   144

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

   145

	bool larger_town;

   146

   147

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

   148

	uint16 radius[5];

   149

   150

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

   151

	BuildingCounts building_counts;

   152

   153

	/**

   154

	 * Creates a new town

   155

	 */

   156

	Town(TileIndex tile = 0);

   157

   158

	/** Destroy the town */

   159

	~Town();

   160

   161

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

   162

};

   163

   164

struct HouseSpec {

   165

	/* Standard properties */

   166

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

   167

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

   168

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

   169

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

   170

	StringID building_name;            ///< building name

   171

	uint16 remove_rating_decrease;     ///< rating decrease if removed

   172

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

   173

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

   174

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

   175

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

   176

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

   177

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

   178

   179

	/* NewHouses properties */

   180

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

   181

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

   182

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

   183

	uint16 callback_mask;              ///< House callback flags

   184

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

   185

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

   186

	HouseExtraFlags extra_flags;       ///< some more flags

   187

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

   188

	byte animation_frames;             ///< number of animation frames

   189

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

   190

	byte processing_time;              ///< Periodic refresh multiplier

   191

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

   192

   193

	/* grf file related properties*/

   194

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

   195

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

   196

};

   197

   198

VARDEF HouseSpec _house_specs[HOUSE_MAX];

   199

   200

uint32 GetWorldPopulation();

   201

   202

void UpdateTownVirtCoord(Town *t);

   203

void UpdateAllTownVirtCoords();

   204

void InitializeTown();

   205

void ShowTownViewWindow(TownID town);

   206

void ExpandTown(Town *t);

   207

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

   208

   209

enum {

   210

	ROAD_REMOVE = 0,

   211

	UNMOVEABLE_REMOVE = 1,

   212

	TUNNELBRIDGE_REMOVE = 1,

   213

	INDUSTRY_REMOVE = 2

   214

};

   215

   216

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

   217

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

   218

 * in TTD. */

   219

static const byte TOWN_GROWTH_FREQUENCY = 70;

   220

   221

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

   222

 * construction. */

   223

static const byte TOWN_HOUSE_COMPLETED = 3;

   224

   225

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

   226

 * IT simply states what bit is used for.

   227

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

   228

 * per town, NO MATTER the population of it.

   229

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

   230

 */

   231

enum {

   232

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

   233

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

   234

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

   235

};

   236

   237

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

   238

   239

VARDEF const Town** _town_sort;

   240

   241

static inline HouseSpec *GetHouseSpecs(HouseID house_id)

   242

{

   243

	assert(house_id < HOUSE_MAX);

   244

	return &_house_specs[house_id];

   245

}

   246

   247

/**

   248

 * Check if a TownID is valid.

   249

 * @param index to inquiry in the pool of town

   250

 * @return true if it exists

   251

 */

   252

static inline bool IsValidTownID(TownID index)

   253

{

   254

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

   255

}

   256

   257

VARDEF uint _total_towns;

   258

   259

static inline TownID GetMaxTownIndex()

   260

{

   261

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

   262

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

   263

	 *  _really_ returns the highest index. Now it just returns

   264

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

   265

	 */

   266

	return GetTownPoolSize() - 1;

   267

}

   268

   269

static inline uint GetNumTowns()

   270

{

   271

	return _total_towns;

   272

}

   273

   274

/**

   275

 * Return a random valid town.

   276

 */

   277

static inline Town *GetRandomTown()

   278

{

   279

	int num = RandomRange(GetNumTowns());

   280

	TownID index = INVALID_TOWN;

   281

   282

	while (num >= 0) {

   283

		num--;

   284

   285

		index++;

   286

		/* Make sure we have a valid town */

   287

		while (!IsValidTownID(index)) {

   288

			index++;

   289

			assert(index <= GetMaxTownIndex());

   290

		}

   291

	}

   292

   293

	return GetTown(index);

   294

}

   295

   296

Town* CalcClosestTownFromTile(TileIndex tile, uint threshold);

   297

   298

#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())

   299

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

   300

   301

VARDEF bool _town_sort_dirty;

   302

VARDEF byte _town_sort_order;

   303

   304

VARDEF Town *_cleared_town;

   305

VARDEF int _cleared_town_rating;

   306

   307

uint OriginalTileRandomiser(uint x, uint y);

   308

void ResetHouses();

   309

   310

void ClearTownHouse(Town *t, TileIndex tile);

   311

void AfterLoadTown();

   312

void UpdateTownMaxPass(Town *t);

   313

bool CheckIfAuthorityAllows(TileIndex tile);

   314

Town *ClosestTownFromTile(TileIndex tile, uint threshold);

   315

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

   316

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

   317

void SetTownRatingTestMode(bool mode);

   318

   319

#endif /* TOWN_H */