1

/* $Id$ */

     2

     3

/** @file town.h */

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

    17

#include "settings_type.h"

    18

    19

enum {

    20

	HOUSE_NO_CLASS   = 0,

    21

	NEW_HOUSE_OFFSET = 110,

    22

	HOUSE_MAX        = 512,

    23

	INVALID_TOWN     = 0xFFFF,

    24

	INVALID_HOUSE_ID = 0xFFFF,

    25

    26

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

    27

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

    28

	HOUSE_CLASS_MAX  = HOUSE_MAX - NEW_HOUSE_OFFSET + 1,

    29

};

    30

    31

enum BuildingFlags {

    32

	TILE_NO_FLAG         =       0,

    33

	TILE_SIZE_1x1        = 1U << 0,

    34

	TILE_NOT_SLOPED      = 1U << 1,

    35

	TILE_SIZE_2x1        = 1U << 2,

    36

	TILE_SIZE_1x2        = 1U << 3,

    37

	TILE_SIZE_2x2        = 1U << 4,

    38

	BUILDING_IS_ANIMATED = 1U << 5,

    39

	BUILDING_IS_CHURCH   = 1U << 6,

    40

	BUILDING_IS_STADIUM  = 1U << 7,

    41

	BUILDING_HAS_1_TILE  = TILE_SIZE_1x1 | TILE_SIZE_2x1 | TILE_SIZE_1x2 | TILE_SIZE_2x2,

    42

	BUILDING_2_TILES_X   = TILE_SIZE_2x1 | TILE_SIZE_2x2,

    43

	BUILDING_2_TILES_Y   = TILE_SIZE_1x2 | TILE_SIZE_2x2,

    44

	BUILDING_HAS_4_TILES = TILE_SIZE_2x2,

    45

};

    46

    47

DECLARE_ENUM_AS_BIT_SET(BuildingFlags)

    48

    49

enum HouseZonesBits {

    50

	HZB_BEGIN     = 0,

    51

	HZB_TOWN_EDGE = 0,

    52

	HZB_TOWN_OUTSKIRT,

    53

	HZB_TOWN_OUTER_SUBURB,

    54

	HZB_TOWN_INNER_SUBURB,

    55

	HZB_TOWN_CENTRE,

    56

	HZB_END,

    57

};

    58

assert_compile(HZB_END == 5);

    59

    60

DECLARE_POSTFIX_INCREMENT(HouseZonesBits)

    61

    62

enum HouseZones {                  ///< Bit  Value       Meaning

    63

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

    64

	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

    65

	HZ_ZON2              = 1U << HZB_TOWN_OUTSKIRT,

    66

	HZ_ZON3              = 1U << HZB_TOWN_OUTER_SUBURB,

    67

	HZ_ZON4              = 1U << HZB_TOWN_INNER_SUBURB,

    68

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

    69

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

    70

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

    71

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

    72

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

    73

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

    74

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

    75

};

    76

    77

DECLARE_ENUM_AS_BIT_SET(HouseZones)

    78

    79

enum HouseExtraFlags {

    80

	NO_EXTRA_FLAG            =       0,

    81

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

    82

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

    83

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

    84

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

    85

};

    86

    87

DECLARE_ENUM_AS_BIT_SET(HouseExtraFlags)

    88

    89

struct BuildingCounts {

    90

	uint8 id_count[HOUSE_MAX];

    91

	uint8 class_count[HOUSE_CLASS_MAX];

    92

};

    93

    94

DECLARE_OLD_POOL(Town, Town, 3, 8000)

    95

    96

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

    97

	TileIndex xy;

    98

    99

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

   100

	uint32 num_houses;

   101

	uint32 population;

   102

   103

	/* Town name */

   104

	uint32 townnamegrfid;

   105

	uint16 townnametype;

   106

	uint32 townnameparts;

   107

	char *name;

   108

   109

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

   110

	ViewportSign sign;

   111

   112

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

   113

	 * bit 0 = Building funds received

   114

	 * bit 1 = CHURCH

   115

	 * bit 2 = STADIUM */

   116

	byte flags12;

   117

   118

	/* Which players have a statue? */

   119

	byte statues;

   120

   121

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

   122

	byte have_ratings;

   123

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

   124

	PlayerByte exclusivity;      ///< which player has exslusivity

   125

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

   126

	int16 ratings[MAX_PLAYERS];

   127

	int16 test_rating;

   128

   129

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

   130

	uint32 max_pass;

   131

	uint32 max_mail;

   132

	uint32 new_max_pass;

   133

	uint32 new_max_mail;

   134

	uint32 act_pass;

   135

	uint32 act_mail;

   136

	uint32 new_act_pass;

   137

	uint32 new_act_mail;

   138

   139

	/* Amount of passengers that were transported. */

   140

	byte pct_pass_transported;

   141

	byte pct_mail_transported;

   142

   143

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

   144

	uint16 act_food;

   145

	uint16 act_water;

   146

	uint16 new_act_food;

   147

	uint16 new_act_water;

   148

   149

	/* Time until we rebuild a house. */

   150

	uint16 time_until_rebuild;

   151

   152

	/* When to grow town next time. */

   153

	uint16 grow_counter;

   154

	int16 growth_rate;

   155

   156

	/* Fund buildings program in action? */

   157

	byte fund_buildings_months;

   158

   159

	/* Fund road reconstruction in action? */

   160

	byte road_build_months;

   161

   162

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

   163

	bool larger_town;

   164

   165

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

   166

	uint16 radius[HZB_END];

   167

   168

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

   169

	BuildingCounts building_counts;

   170

   171

	/* NOSAVE: The town specific road layout */

   172

	TownLayout layout;

   173

   174

	/**

   175

	 * Creates a new town

   176

	 */

   177

	Town(TileIndex tile = 0);

   178

   179

	/** Destroy the town */

   180

	~Town();

   181

   182

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

   183

   184

	void InitializeLayout();

   185

   186

	inline TownLayout GetActiveLayout() const;

   187

};

   188

   189

/**

   190

 * Get the current valid layout for the town

   191

 * @return the active layout for this town

   192

 */

   193

inline TownLayout Town::GetActiveLayout() const

   194

{

   195

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

   196

}

   197

   198

struct HouseSpec {

   199

	/* Standard properties */

   200

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

   201

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

   202

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

   203

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

   204

	GRFMappedStringID building_name;   ///< building name

   205

	uint16 remove_rating_decrease;     ///< rating decrease if removed

   206

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

   207

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

   208

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

   209

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

   210

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

   211

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

   212

   213

	/* NewHouses properties */

   214

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

   215

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

   216

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

   217

	uint16 callback_mask;              ///< House callback flags

   218

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

   219

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

   220

	HouseExtraFlags extra_flags;       ///< some more flags

   221

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

   222

	byte animation_frames;             ///< number of animation frames

   223

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

   224

	byte processing_time;              ///< Periodic refresh multiplier

   225

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

   226

   227

	/* grf file related properties*/

   228

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

   229

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

   230

};

   231

   232

extern HouseSpec _house_specs[HOUSE_MAX];

   233

   234

uint32 GetWorldPopulation();

   235

   236

void UpdateTownVirtCoord(Town *t);

   237

void UpdateAllTownVirtCoords();

   238

void InitializeTown();

   239

void ShowTownViewWindow(TownID town);

   240

void ExpandTown(Town *t);

   241

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

   242

   243

enum {

   244

	ROAD_REMOVE = 0,

   245

	UNMOVEABLE_REMOVE = 1,

   246

	TUNNELBRIDGE_REMOVE = 1,

   247

	INDUSTRY_REMOVE = 2

   248

};

   249

   250

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

   251

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

   252

 * in TTD. */

   253

static const byte TOWN_GROWTH_FREQUENCY = 70;

   254

   255

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

   256

 * construction. */

   257

static const byte TOWN_HOUSE_COMPLETED = 3;

   258

   259

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

   260

 * IT simply states what bit is used for.

   261

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

   262

 * per town, NO MATTER the population of it.

   263

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

   264

 */

   265

enum {

   266

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

   267

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

   268

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

   269

};

   270

   271

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

   272

   273

static inline HouseSpec *GetHouseSpecs(HouseID house_id)

   274

{

   275

	assert(house_id < HOUSE_MAX);

   276

	return &_house_specs[house_id];

   277

}

   278

   279

/**

   280

 * Check if a TownID is valid.

   281

 * @param index to inquiry in the pool of town

   282

 * @return true if it exists

   283

 */

   284

static inline bool IsValidTownID(TownID index)

   285

{

   286

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

   287

}

   288

   289

static inline TownID GetMaxTownIndex()

   290

{

   291

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

   292

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

   293

	 *  _really_ returns the highest index. Now it just returns

   294

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

   295

	 */

   296

	return GetTownPoolSize() - 1;

   297

}

   298

   299

static inline uint GetNumTowns()

   300

{

   301

	extern uint _total_towns;

   302

   303

	return _total_towns;

   304

}

   305

   306

/**

   307

 * Return a random valid town.

   308

 */

   309

static inline Town *GetRandomTown()

   310

{

   311

	int num = RandomRange(GetNumTowns());

   312

	TownID index = INVALID_TOWN;

   313

   314

	while (num >= 0) {

   315

		num--;

   316

   317

		index++;

   318

		/* Make sure we have a valid town */

   319

		while (!IsValidTownID(index)) {

   320

			index++;

   321

			assert(index <= GetMaxTownIndex());

   322

		}

   323

	}

   324

   325

	return GetTown(index);

   326

}

   327

   328

Town *CalcClosestTownFromTile(TileIndex tile, uint threshold);

   329

   330

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

   331

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

   332

   333

extern bool _town_sort_dirty;

   334

extern byte _town_sort_order;

   335

extern const Town **_town_sort;

   336

   337

extern Town *_cleared_town;

   338

extern int _cleared_town_rating;

   339

   340

void ResetHouses();

   341

   342

void ClearTownHouse(Town *t, TileIndex tile);

   343

void AfterLoadTown();

   344

void UpdateTownMaxPass(Town *t);

   345

void UpdateTownRadius(Town *t);

   346

bool CheckIfAuthorityAllows(TileIndex tile);

   347

Town *ClosestTownFromTile(TileIndex tile, uint threshold);

   348

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

   349

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

   350

void SetTownRatingTestMode(bool mode);

   351

   352

/**

   353

 * Calculate a hash value from a tile position

   354

 *

   355

 * @param x The X coordinate

   356

 * @param y The Y coordinate

   357

 * @return The hash of the tile

   358

 */

   359

static inline uint TileHash(uint x, uint y)

   360

{

   361

	uint hash = x >> 4;

   362

	hash ^= x >> 6;

   363

	hash ^= y >> 4;

   364

	hash -= y >> 6;

   365

	return hash;

   366

}

   367

   368

/**

   369

 * Get the last two bits of the TileHash

   370

 *  from a tile position.

   371

 *

   372

 * @see TileHash()

   373

 * @param x The X coordinate

   374

 * @param y The Y coordinate

   375

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

   376

 */

   377

static inline uint TileHash2Bit(uint x, uint y)

   378

{

   379

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

   380

}

   381

   382

#endif /* TOWN_H */