1

/* $Id$ */

     2

     3

/** @file town.h Base of the town class. */

     4

     5

#ifndef TOWN_H

     6

#define TOWN_H

     7

     8

#include "oldpool.h"

     9

#include "core/bitmath_func.hpp"

    10

#include "core/random_func.hpp"

    11

#include "cargo_type.h"

    12

#include "tile_type.h"

    13

#include "date_type.h"

    14

#include "town_type.h"

    15

#include "company_type.h"

    16

#include "settings_type.h"

    17

#include "strings_type.h"

    18

#include "viewport_type.h"

    19

#include "economy_type.h"

    20

    21

enum {

    22

	HOUSE_NO_CLASS   = 0,

    23

	NEW_HOUSE_OFFSET = 110,

    24

	HOUSE_MAX        = 512,

    25

	INVALID_TOWN     = 0xFFFF,

    26

	INVALID_HOUSE_ID = 0xFFFF,

    27

    28

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

    29

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

    30

	HOUSE_CLASS_MAX  = HOUSE_MAX - NEW_HOUSE_OFFSET + 1,

    31

};

    32

    33

enum BuildingFlags {

    34

	TILE_NO_FLAG         =       0,

    35

	TILE_SIZE_1x1        = 1U << 0,

    36

	TILE_NOT_SLOPED      = 1U << 1,

    37

	TILE_SIZE_2x1        = 1U << 2,

    38

	TILE_SIZE_1x2        = 1U << 3,

    39

	TILE_SIZE_2x2        = 1U << 4,

    40

	BUILDING_IS_ANIMATED = 1U << 5,

    41

	BUILDING_IS_CHURCH   = 1U << 6,

    42

	BUILDING_IS_STADIUM  = 1U << 7,

    43

	BUILDING_HAS_1_TILE  = TILE_SIZE_1x1 | TILE_SIZE_2x1 | TILE_SIZE_1x2 | TILE_SIZE_2x2,

    44

	BUILDING_2_TILES_X   = TILE_SIZE_2x1 | TILE_SIZE_2x2,

    45

	BUILDING_2_TILES_Y   = TILE_SIZE_1x2 | TILE_SIZE_2x2,

    46

	BUILDING_HAS_4_TILES = TILE_SIZE_2x2,

    47

};

    48

    49

DECLARE_ENUM_AS_BIT_SET(BuildingFlags)

    50

    51

enum HouseZonesBits {

    52

	HZB_BEGIN     = 0,

    53

	HZB_TOWN_EDGE = 0,

    54

	HZB_TOWN_OUTSKIRT,

    55

	HZB_TOWN_OUTER_SUBURB,

    56

	HZB_TOWN_INNER_SUBURB,

    57

	HZB_TOWN_CENTRE,

    58

	HZB_END,

    59

};

    60

assert_compile(HZB_END == 5);

    61

    62

DECLARE_POSTFIX_INCREMENT(HouseZonesBits)

    63

    64

enum HouseZones {                  ///< Bit  Value       Meaning

    65

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

    66

	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

    67

	HZ_ZON2              = 1U << HZB_TOWN_OUTSKIRT,

    68

	HZ_ZON3              = 1U << HZB_TOWN_OUTER_SUBURB,

    69

	HZ_ZON4              = 1U << HZB_TOWN_INNER_SUBURB,

    70

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

    71

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

    72

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

    73

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

    74

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

    75

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

    76

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

    77

};

    78

    79

DECLARE_ENUM_AS_BIT_SET(HouseZones)

    80

    81

enum HouseExtraFlags {

    82

	NO_EXTRA_FLAG            =       0,

    83

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

    84

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

    85

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

    86

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

    87

};

    88

    89

DECLARE_ENUM_AS_BIT_SET(HouseExtraFlags)

    90

    91

struct BuildingCounts {

    92

	uint8 id_count[HOUSE_MAX];

    93

	uint8 class_count[HOUSE_CLASS_MAX];

    94

};

    95

    96

DECLARE_OLD_POOL(Town, Town, 3, 8000)

    97

    98

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

    99

	TileIndex xy;

   100

   101

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

   102

	uint32 num_houses;

   103

	uint32 population;

   104

   105

	/* Town name */

   106

	uint32 townnamegrfid;

   107

	uint16 townnametype;

   108

	uint32 townnameparts;

   109

	char *name;

   110

   111

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

   112

	ViewportSign sign;

   113

   114

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

   115

	 * bit 0 = Building funds received

   116

	 * bit 1 = CHURCH

   117

	 * bit 2 = STADIUM */

   118

	byte flags12;

   119

   120

	/* level of noise that all the airports are generating */

   121

	uint16 noise_reached;

   122

   123

	/* Which companies have a statue? */

   124

	byte statues;

   125

   126

	/* Company ratings as well as a mask that determines which companies have a rating. */

   127

	CompanyMask have_ratings;

   128

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

   129

	CompanyByte exclusivity;       ///< which company has exclusivity

   130

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

   131

	int16 ratings[MAX_COMPANIES];

   132

   133

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

   134

	uint32 max_pass;

   135

	uint32 max_mail;

   136

	uint32 new_max_pass;

   137

	uint32 new_max_mail;

   138

	uint32 act_pass;

   139

	uint32 act_mail;

   140

	uint32 new_act_pass;

   141

	uint32 new_act_mail;

   142

   143

	/* Amount of passengers that were transported. */

   144

	byte pct_pass_transported;

   145

	byte pct_mail_transported;

   146

   147

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

   148

	uint16 act_food;

   149

	uint16 act_water;

   150

	uint16 new_act_food;

   151

	uint16 new_act_water;

   152

   153

	/* Time until we rebuild a house. */

   154

	uint16 time_until_rebuild;

   155

   156

	/* When to grow town next time. */

   157

	uint16 grow_counter;

   158

	int16 growth_rate;

   159

   160

	/* Fund buildings program in action? */

   161

	byte fund_buildings_months;

   162

   163

	/* Fund road reconstruction in action? */

   164

	byte road_build_months;

   165

   166

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

   167

	bool larger_town;

   168

   169

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

   170

	uint32 squared_town_zone_radius[HZB_END];

   171

   172

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

   173

	BuildingCounts building_counts;

   174

   175

	/* NOSAVE: The town specific road layout */

   176

	TownLayout layout;

   177

   178

	/**

   179

	 * Creates a new town

   180

	 */

   181

	Town(TileIndex tile = 0);

   182

   183

	/** Destroy the town */

   184

	~Town();

   185

   186

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

   187

   188

	void InitializeLayout();

   189

   190

	inline TownLayout GetActiveLayout() const;

   191

   192

	/** Calculate the max town noise

   193

	 * The value is counted using the population divided by the content of the

   194

	 * entry in town_noise_population corespondig to the town's tolerance.

   195

	 * To this result, we add 3, which is the noise of the lowest airport.

   196

	 * So user can at least buld that airport

   197

	 * @return the maximum noise level the town will tolerate */

   198

	inline uint16 MaxTownNoise() const {

   199

		if (this->population == 0) return 0; // no population? no noise

   200

   201

		return ((this->population / _settings_game.economy.town_noise_population[_settings_game.difficulty.town_council_tolerance]) + 3);

   202

	}

   203

};

   204

   205

/**

   206

 * Get the current valid layout for the town

   207

 * @return the active layout for this town

   208

 */

   209

inline TownLayout Town::GetActiveLayout() const

   210

{

   211

	return (_settings_game.economy.town_layout == TL_RANDOM) ? this->layout : _settings_game.economy.town_layout;

   212

}

   213

   214

struct HouseSpec {

   215

	/* Standard properties */

   216

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

   217

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

   218

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

   219

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

   220

	StringID building_name;            ///< building name

   221

	uint16 remove_rating_decrease;     ///< rating decrease if removed

   222

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

   223

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

   224

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

   225

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

   226

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

   227

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

   228

   229

	/* NewHouses properties */

   230

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

   231

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

   232

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

   233

	uint16 callback_mask;              ///< House callback flags

   234

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

   235

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

   236

	HouseExtraFlags extra_flags;       ///< some more flags

   237

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

   238

	byte animation_frames;             ///< number of animation frames

   239

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

   240

	byte processing_time;              ///< Periodic refresh multiplier

   241

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

   242

   243

	/* grf file related properties*/

   244

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

   245

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

   246

   247

	/**

   248

	 * Get the cost for removing this house

   249

	 * @return the cost (inflation corrected etc)

   250

	 */

   251

	Money GetRemovalCost() const;

   252

   253

};

   254

   255

extern HouseSpec _house_specs[HOUSE_MAX];

   256

   257

uint32 GetWorldPopulation();

   258

   259

void UpdateTownVirtCoord(Town *t);

   260

void UpdateAllTownVirtCoords();

   261

void InitializeTown();

   262

void ShowTownViewWindow(TownID town);

   263

void ExpandTown(Town *t);

   264

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

   265

   266

enum {

   267

	ROAD_REMOVE = 0,

   268

	UNMOVEABLE_REMOVE = 1,

   269

	TUNNELBRIDGE_REMOVE = 1,

   270

	INDUSTRY_REMOVE = 2

   271

};

   272

   273

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

   274

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

   275

 * in TTD. */

   276

static const byte TOWN_GROWTH_FREQUENCY = 70;

   277

   278

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

   279

 * construction. */

   280

static const byte TOWN_HOUSE_COMPLETED = 3;

   281

   282

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

   283

 * IT simply states what bit is used for.

   284

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

   285

 * per town, NO MATTER the population of it.

   286

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

   287

 */

   288

enum {

   289

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

   290

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

   291

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

   292

};

   293

   294

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

   295

   296

static inline HouseSpec *GetHouseSpecs(HouseID house_id)

   297

{

   298

	assert(house_id < HOUSE_MAX);

   299

	return &_house_specs[house_id];

   300

}

   301

   302

TileIndex GetHouseNorthPart(HouseID &house);

   303

   304

/**

   305

 * Check if a TownID is valid.

   306

 * @param index to inquiry in the pool of town

   307

 * @return true if it exists

   308

 */

   309

static inline bool IsValidTownID(TownID index)

   310

{

   311

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

   312

}

   313

   314

static inline TownID GetMaxTownIndex()

   315

{

   316

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

   317

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

   318

	 *  _really_ returns the highest index. Now it just returns

   319

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

   320

	 */

   321

	return GetTownPoolSize() - 1;

   322

}

   323

   324

static inline uint GetNumTowns()

   325

{

   326

	extern uint _total_towns;

   327

   328

	return _total_towns;

   329

}

   330

   331

/**

   332

 * Return a random valid town.

   333

 */

   334

static inline Town *GetRandomTown()

   335

{

   336

	int num = RandomRange(GetNumTowns());

   337

	TownID index = INVALID_TOWN;

   338

   339

	while (num >= 0) {

   340

		num--;

   341

   342

		index++;

   343

		/* Make sure we have a valid town */

   344

		while (!IsValidTownID(index)) {

   345

			index++;

   346

			assert(index <= GetMaxTownIndex());

   347

		}

   348

	}

   349

   350

	return GetTown(index);

   351

}

   352

   353

Town *CalcClosestTownFromTile(TileIndex tile, uint threshold);

   354

   355

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

   356

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

   357

   358

extern Town *_cleared_town;

   359

extern int _cleared_town_rating;

   360

   361

void ResetHouses();

   362

   363

void ClearTownHouse(Town *t, TileIndex tile);

   364

void AfterLoadTown();

   365

void UpdateTownMaxPass(Town *t);

   366

void UpdateTownRadius(Town *t);

   367

bool CheckIfAuthorityAllows(TileIndex tile);

   368

Town *ClosestTownFromTile(TileIndex tile, uint threshold);

   369

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

   370

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

   371

void SetTownRatingTestMode(bool mode);

   372

   373

/**

   374

 * Calculate a hash value from a tile position

   375

 *

   376

 * @param x The X coordinate

   377

 * @param y The Y coordinate

   378

 * @return The hash of the tile

   379

 */

   380

static inline uint TileHash(uint x, uint y)

   381

{

   382

	uint hash = x >> 4;

   383

	hash ^= x >> 6;

   384

	hash ^= y >> 4;

   385

	hash -= y >> 6;

   386

	return hash;

   387

}

   388

   389

/**

   390

 * Get the last two bits of the TileHash

   391

 *  from a tile position.

   392

 *

   393

 * @see TileHash()

   394

 * @param x The X coordinate

   395

 * @param y The Y coordinate

   396

 * @return The last two bits from hash of the tile

   397

 */

   398

static inline uint TileHash2Bit(uint x, uint y)

   399

{

   400

	return GB(TileHash(x, y), 0, 2);

   401

}

   402

   403

#endif /* TOWN_H */