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 "player_type.h"

    16

#include "settings_type.h"

    17

#include "strings_type.h"

    18

#include "viewport_type.h"

    19

    20

enum {

    21

	HOUSE_NO_CLASS   = 0,

    22

	NEW_HOUSE_OFFSET = 110,

    23

	HOUSE_MAX        = 512,

    24

	INVALID_TOWN     = 0xFFFF,

    25

	INVALID_HOUSE_ID = 0xFFFF,

    26

    27

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

    28

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

    29

	HOUSE_CLASS_MAX  = HOUSE_MAX - NEW_HOUSE_OFFSET + 1,

    30

};

    31

    32

enum BuildingFlags {

    33

	TILE_NO_FLAG         =       0,

    34

	TILE_SIZE_1x1        = 1U << 0,

    35

	TILE_NOT_SLOPED      = 1U << 1,

    36

	TILE_SIZE_2x1        = 1U << 2,

    37

	TILE_SIZE_1x2        = 1U << 3,

    38

	TILE_SIZE_2x2        = 1U << 4,

    39

	BUILDING_IS_ANIMATED = 1U << 5,

    40

	BUILDING_IS_CHURCH   = 1U << 6,

    41

	BUILDING_IS_STADIUM  = 1U << 7,

    42

	BUILDING_HAS_1_TILE  = TILE_SIZE_1x1 | TILE_SIZE_2x1 | TILE_SIZE_1x2 | TILE_SIZE_2x2,

    43

	BUILDING_2_TILES_X   = TILE_SIZE_2x1 | TILE_SIZE_2x2,

    44

	BUILDING_2_TILES_Y   = TILE_SIZE_1x2 | TILE_SIZE_2x2,

    45

	BUILDING_HAS_4_TILES = TILE_SIZE_2x2,

    46

};

    47

    48

DECLARE_ENUM_AS_BIT_SET(BuildingFlags)

    49

    50

enum HouseZonesBits {

    51

	HZB_BEGIN     = 0,

    52

	HZB_TOWN_EDGE = 0,

    53

	HZB_TOWN_OUTSKIRT,

    54

	HZB_TOWN_OUTER_SUBURB,

    55

	HZB_TOWN_INNER_SUBURB,

    56

	HZB_TOWN_CENTRE,

    57

	HZB_END,

    58

};

    59

assert_compile(HZB_END == 5);

    60

    61

DECLARE_POSTFIX_INCREMENT(HouseZonesBits)

    62

    63

enum HouseZones {                  ///< Bit  Value       Meaning

    64

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

    65

	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

    66

	HZ_ZON2              = 1U << HZB_TOWN_OUTSKIRT,

    67

	HZ_ZON3              = 1U << HZB_TOWN_OUTER_SUBURB,

    68

	HZ_ZON4              = 1U << HZB_TOWN_INNER_SUBURB,

    69

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

    70

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

    71

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

    72

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

    73

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

    74

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

    75

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

    76

};

    77

    78

DECLARE_ENUM_AS_BIT_SET(HouseZones)

    79

    80

enum HouseExtraFlags {

    81

	NO_EXTRA_FLAG            =       0,

    82

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

    83

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

    84

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

    85

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

    86

};

    87

    88

DECLARE_ENUM_AS_BIT_SET(HouseExtraFlags)

    89

    90

struct BuildingCounts {

    91

	uint8 id_count[HOUSE_MAX];

    92

	uint8 class_count[HOUSE_CLASS_MAX];

    93

};

    94

    95

DECLARE_OLD_POOL(Town, Town, 3, 8000)

    96

    97

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

    98

	TileIndex xy;

    99

   100

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

   101

	uint32 num_houses;

   102

	uint32 population;

   103

   104

	/* Town name */

   105

	uint32 townnamegrfid;

   106

	uint16 townnametype;

   107

	uint32 townnameparts;

   108

	char *name;

   109

   110

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

   111

	ViewportSign sign;

   112

   113

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

   114

	 * bit 0 = Building funds received

   115

	 * bit 1 = CHURCH

   116

	 * bit 2 = STADIUM */

   117

	byte flags12;

   118

   119

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

   120

	uint16 noise_reached;

   121

   122

	/* Which players have a statue? */

   123

	byte statues;

   124

   125

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

   126

	byte have_ratings;

   127

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

   128

	PlayerByte exclusivity;      ///< which player has exslusivity

   129

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

   130

	int16 ratings[MAX_PLAYERS];

   131

   132

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

   133

	uint32 max_pass;

   134

	uint32 max_mail;

   135

	uint32 new_max_pass;

   136

	uint32 new_max_mail;

   137

	uint32 act_pass;

   138

	uint32 act_mail;

   139

	uint32 new_act_pass;

   140

	uint32 new_act_mail;

   141

   142

	/* Amount of passengers that were transported. */

   143

	byte pct_pass_transported;

   144

	byte pct_mail_transported;

   145

   146

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

   147

	uint16 act_food;

   148

	uint16 act_water;

   149

	uint16 new_act_food;

   150

	uint16 new_act_water;

   151

   152

	/* Time until we rebuild a house. */

   153

	uint16 time_until_rebuild;

   154

   155

	/* When to grow town next time. */

   156

	uint16 grow_counter;

   157

	int16 growth_rate;

   158

   159

	/* Fund buildings program in action? */

   160

	byte fund_buildings_months;

   161

   162

	/* Fund road reconstruction in action? */

   163

	byte road_build_months;

   164

   165

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

   166

	bool larger_town;

   167

   168

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

   169

	uint32 squared_town_zone_radius[HZB_END];

   170

   171

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

   172

	BuildingCounts building_counts;

   173

   174

	/* NOSAVE: The town specific road layout */

   175

	TownLayout layout;

   176

   177

	/**

   178

	 * Creates a new town

   179

	 */

   180

	Town(TileIndex tile = 0);

   181

   182

	/** Destroy the town */

   183

	~Town();

   184

   185

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

   186

   187

	void InitializeLayout();

   188

   189

	inline TownLayout GetActiveLayout() const;

   190

   191

	/** Calculate the max town noise

   192

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

   193

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

   194

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

   195

	 * So user can at least buld that airport

   196

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

   197

	inline uint16 MaxTownNoise() const {

   198

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

   199

   201

	}

   202

};

   203

   204

/**

   205

 * Get the current valid layout for the town

   206

 * @return the active layout for this town

   207

 */

   208

inline TownLayout Town::GetActiveLayout() const

   209

{

   211

}

   212

   213

struct HouseSpec {

   214

	/* Standard properties */

   215

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

   216

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

   217

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

   218

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

   219

	StringID building_name;            ///< building name

   220

	uint16 remove_rating_decrease;     ///< rating decrease if removed

   221

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

   222

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

   223

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

   224

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

   225

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

   226

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

   227

   228

	/* NewHouses properties */

   229

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

   230

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

   231

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

   232

	uint16 callback_mask;              ///< House callback flags

   233

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

   234

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

   235

	HouseExtraFlags extra_flags;       ///< some more flags

   236

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

   237

	byte animation_frames;             ///< number of animation frames

   238

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

   239

	byte processing_time;              ///< Periodic refresh multiplier

   240

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

   241

   242

	/* grf file related properties*/

   243

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

   244

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

   245

};

   246

   247

extern HouseSpec _house_specs[HOUSE_MAX];

   248

   249

uint32 GetWorldPopulation();

   250

   251

void UpdateTownVirtCoord(Town *t);

   252

void UpdateAllTownVirtCoords();

   253

void InitializeTown();

   254

void ShowTownViewWindow(TownID town);

   255

void ExpandTown(Town *t);

   256

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

   257

   258

enum {

   259

	ROAD_REMOVE = 0,

   260

	UNMOVEABLE_REMOVE = 1,

   261

	TUNNELBRIDGE_REMOVE = 1,

   262

	INDUSTRY_REMOVE = 2

   263

};

   264

   265

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

   266

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

   267

 * in TTD. */

   268

static const byte TOWN_GROWTH_FREQUENCY = 70;

   269

   270

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

   271

 * construction. */

   272

static const byte TOWN_HOUSE_COMPLETED = 3;

   273

   274

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

   275

 * IT simply states what bit is used for.

   276

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

   277

 * per town, NO MATTER the population of it.

   278

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

   279

 */

   280

enum {

   281

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

   282

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

   283

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

   284

};

   285

   286

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

   287

   288

static inline HouseSpec *GetHouseSpecs(HouseID house_id)

   289

{

   290

	assert(house_id < HOUSE_MAX);

   291

	return &_house_specs[house_id];

   292

}

   293

   294

/**

   295

 * Check if a TownID is valid.

   296

 * @param index to inquiry in the pool of town

   297

 * @return true if it exists

   298

 */

   299

static inline bool IsValidTownID(TownID index)

   300

{

   301

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

   302

}

   303

   304

static inline TownID GetMaxTownIndex()

   305

{

   306

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

   307

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

   308

	 *  _really_ returns the highest index. Now it just returns

   309

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

   310

	 */

   311

	return GetTownPoolSize() - 1;

   312

}

   313

   314

static inline uint GetNumTowns()

   315

{

   316

	extern uint _total_towns;

   317

   318

	return _total_towns;

   319

}

   320

   321

/**

   322

 * Return a random valid town.

   323

 */

   324

static inline Town *GetRandomTown()

   325

{

   326

	int num = RandomRange(GetNumTowns());

   327

	TownID index = INVALID_TOWN;

   328

   329

	while (num >= 0) {

   330

		num--;

   331

   332

		index++;

   333

		/* Make sure we have a valid town */

   334

		while (!IsValidTownID(index)) {

   335

			index++;

   336

			assert(index <= GetMaxTownIndex());

   337

		}

   338

	}

   339

   340

	return GetTown(index);

   341

}

   342

   343

Town *CalcClosestTownFromTile(TileIndex tile, uint threshold);

   344

   345

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

   346

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

   347

   348

extern Town *_cleared_town;

   349

extern int _cleared_town_rating;

   350

   351

void ResetHouses();

   352

   353

void ClearTownHouse(Town *t, TileIndex tile);

   354

void AfterLoadTown();

   355

void UpdateTownMaxPass(Town *t);

   356

void UpdateTownRadius(Town *t);

   357

bool CheckIfAuthorityAllows(TileIndex tile);

   358

Town *ClosestTownFromTile(TileIndex tile, uint threshold);

   359

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

   360

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

   361

void SetTownRatingTestMode(bool mode);

   362

   363

/**

   364

 * Calculate a hash value from a tile position

   365

 *

   366

 * @param x The X coordinate

   367

 * @param y The Y coordinate

   368

 * @return The hash of the tile

   369

 */

   370

static inline uint TileHash(uint x, uint y)

   371

{

   372

	uint hash = x >> 4;

   373

	hash ^= x >> 6;

   374

	hash ^= y >> 4;

   375

	hash -= y >> 6;

   376

	return hash;

   377

}

   378

   379

/**

   380

 * Get the last two bits of the TileHash

   381

 *  from a tile position.

   382

 *

   383

 * @see TileHash()

   384

 * @param x The X coordinate

   385

 * @param y The Y coordinate

   386

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

   387

 */

   388

static inline uint TileHash2Bit(uint x, uint y)

   389

{

   390

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

   391

}

   392

   393

#endif /* TOWN_H */