1

/* $Id$ */

     2

     3

#ifndef TOWN_H

     4

#define TOWN_H

     5

     6

#include "oldpool.h"

     7

#include "player.h"

     8

#include "economy_new.h"

     9

#include "saveload.h"

    10

#include "functions.h"

    11

#include "helpers.hpp"

    12

    13

enum {

    14

	HOUSE_NO_CLASS   = 0,

    15

	NEW_HOUSE_OFFSET = 110,

    16

	HOUSE_MAX        = 512,

    17

	INVALID_TOWN     = 0xFFFF,

    18

	INVALID_HOUSE_ID = 0xFFFF,

    19

    20

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

    21

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

    22

	HOUSE_CLASS_MAX  = HOUSE_MAX - NEW_HOUSE_OFFSET + 1,

    23

};

    24

    25

enum BuildingFlags {

    26

	TILE_NO_FLAG         =       0,

    27

	TILE_SIZE_1x1        = 1U << 0,

    28

	TILE_NOT_SLOPED      = 1U << 1,

    29

	TILE_SIZE_2x1        = 1U << 2,

    30

	TILE_SIZE_1x2        = 1U << 3,

    31

	TILE_SIZE_2x2        = 1U << 4,

    32

	BUILDING_IS_ANIMATED = 1U << 5,

    33

	BUILDING_IS_CHURCH   = 1U << 6,

    34

	BUILDING_IS_STADIUM  = 1U << 7,

    35

	BUILDING_HAS_1_TILE  = TILE_SIZE_1x1 | TILE_SIZE_2x1 | TILE_SIZE_1x2 | TILE_SIZE_2x2,

    36

	BUILDING_2_TILES_X   = TILE_SIZE_2x1 | TILE_SIZE_2x2,

    37

	BUILDING_2_TILES_Y   = TILE_SIZE_1x2 | TILE_SIZE_2x2,

    38

	BUILDING_HAS_4_TILES = TILE_SIZE_2x2,

    39

};

    40

    41

DECLARE_ENUM_AS_BIT_SET(BuildingFlags)

    42

    43

enum HouseZones {                  ///< Bit  Value       Meaning

    44

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

    45

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

    46

	HZ_ZON2              = 0x0002,

    47

	HZ_ZON3              = 0x0004,

    48

	HZ_ZON4              = 0x0008,

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

};

    57

    58

DECLARE_ENUM_AS_BIT_SET(HouseZones)

    59

    60

enum HouseExtraFlags {

    61

	NO_EXTRA_FLAG            =       0,

    62

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

    63

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

    64

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

    65

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

    66

};

    67

    68

DECLARE_ENUM_AS_BIT_SET(HouseExtraFlags)

    69

    70

typedef uint16 HouseID;

    71

typedef uint16 HouseClassID;

    72

    73

struct BuildingCounts {

    74

	uint8 id_count[HOUSE_MAX];

    75

	uint8 class_count[HOUSE_CLASS_MAX];

    76

};

    77

    78

struct Town : EconomicObject {

    79

	TileIndex xy;

    80

    81

	// Current population of people and amount of houses.

    82

	uint16 num_houses;

    83

	uint32 population;

    84

    85

	// Town name

    86

	uint16 townnametype;

    87

	uint32 townnameparts;

    88

    89

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

    90

	ViewportSign sign;

    91

    92

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

    93

	// bit 0 = Building funds received

    94

	// bit 1 = CHURCH

    95

	// bit 2 = STADIUM

    96

	byte flags12;

    97

    98

	// Which players have a statue?

    99

	byte statues;

   100

   101

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

   102

	byte have_ratings;

   103

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

   104

	PlayerByte exclusivity;        // which player has exslusivity

   105

	uint8 exclusive_counter;     // months till the exclusivity expires

   106

	int16 ratings[MAX_PLAYERS];

   107

   108

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

   109

	uint32 max_pass;

   110

	uint32 max_mail;

   111

	uint32 new_max_pass;

   112

	uint32 new_max_mail;

   113

	uint32 act_pass;

   114

	uint32 act_mail;

   115

	uint32 new_act_pass;

   116

	uint32 new_act_mail;

   117

   118

	// Amount of passengers that were transported.

   119

	byte pct_pass_transported;

   120

	byte pct_mail_transported;

   121

   122

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

   123

	uint16 act_food;

   124

	uint16 act_water;

   125

	uint16 new_act_food;

   126

	uint16 new_act_water;

   127

   128

	// Time until we rebuild a house.

   129

	byte time_until_rebuild;

   130

   131

	// When to grow town next time.

   132

	byte grow_counter;

   133

	byte growth_rate;

   134

   135

	// Fund buildings program in action?

   136

	byte fund_buildings_months;

   137

   138

	// Fund road reconstruction in action?

   139

	byte road_build_months;

   140

   141

	// Index in town array

   142

	TownID index;

   143

   144

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

   145

	uint16 radius[5];

   146

   147

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

   148

	BuildingCounts building_counts;

   149

   150

	/**

   151

	 * Sets the economic activity level of a town

   152

	 * @param level The activity level

   153

	 */

   154

	/* virtual */

   155

	template <typename T>

   156

	void SetActivity(T level)

   157

	{

   158

		DEBUG(eco, 7, "Setting EAL of town %d [0x%x] to %f", index, xy, (double)level);

   159

		m_activity_level = level;

   160

	}

   161

   162

	byte GetWealthLevel() const

   163

	{

   164

		FixedT<int32, 16> level = GetActivity() * 10;

   165

		if (level <  7) return 0;

   166

		if (level <  9) return 1;

   167

		if (level < 12) return 2;

   168

		if (level < 15) return 3;

   169

		return 4;

   170

	}

   171

   172

	/**

   182

	 * Adjusts the activity level of a town dependent

   183

	 * on player performance. Towns with a high share of

   184

	 * transported passengers are increasing the EAL, those

   185

	 * with a low share of transported passengers will

   186

	 * see a reduction in activity. In order to not wreck

   187

	 * new games (where no or almost no towns) are connected

   188

	 * and thus have zero transported passengers, These

   189

	 * will be untouched.

   190

	 * @pre Must be called BEFORE UpdateAmounts

   191

	 */

   192

	void UpdateActivity();

   193

   194

	/**

   195

	 * Gets the so ralled "town radius group" of a tile which is a

   196

	 * representation of how close a tile is relative to the town

   197

	 * center depending on the size of the town

   198

	 * @param tile            The tile which the town radius is to be computed for

   199

	 * @param ignore_funding  When a player opted to fund buildings, select the

   200

	 *                        appropriate group unless this flag is set.

   201

	 * @return                The town radius group

   202

	 */

   203

	uint GetRadiusGroup(TileIndex tile, bool ignore_funding = false) const;

   204

   205

	/**

   206

	 * Obtains the highest Town Radius Group a town is in.

   207

	 * @param [in]  tile  The tile which to find the radius group for

   208

	 * @param [out] group The group for in which tile is located

   209

	 * @return            The town to which 'group' belongs

   210

	 */

   211

	static const Town *GetRadiusGroupForTile(TileIndex tile, uint &group);

   212

   213

	/**

   214

	 * Descriptor for the "town" part of the savegame

   215

	 */

   216

	static const SaveLoad town_desc[];

   217

};

   218

   219

struct HouseSpec {

   220

	/* Standard properties */

   221

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

   222

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

   223

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

   224

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

   225

	StringID building_name;            ///< building name

   226

	uint16 remove_rating_decrease;     ///< rating decrease if removed

   227

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

   228

	byte passenger_acceptance;         ///< passenger acceptance, given in 1/8th unit, max is 8, as the 3 next properies

   229

	byte mail_acceptance;              ///< mail acceptance

   230

	byte goods_acceptance;             ///< good acceptance

   231

	byte food_acceptance;              ///< food (or fizzy drink) acceptance

   232

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

   233

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

   234

	bool enabled;                      ///< the house is still avaible (by default, true.newgrf can disable it, though)

   235

   236

	/* NewHouses properties */

   237

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

   238

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

   239

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

   240

	uint16 callback_mask;              ///< House callback flags

   241

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

   242

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

   243

	HouseExtraFlags extra_flags;       ///< some more flags

   244

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

   245

	byte animation_frames;             ///< number of animation frames

   246

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

   247

	byte processing_time;              ///< Periodic refresh multiplier

   248

   249

	/* grf file related properties*/

   250

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

   251

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

   252

};

   253

   254

VARDEF HouseSpec _house_specs[HOUSE_MAX];

   255

   256

uint32 GetWorldPopulation();

   257

   258

void UpdateTownVirtCoord(Town *t);

   259

void InitializeTown();

   260

void ShowTownViewWindow(TownID town);

   261

void ExpandTown(Town *t);

   262

Town *CreateRandomTown(uint attempts, uint size_mode);

   263

   264

enum {

   265

	ROAD_REMOVE = 0,

   266

	UNMOVEABLE_REMOVE = 1,

   267

	TUNNELBRIDGE_REMOVE = 1,

   268

	INDUSTRY_REMOVE = 2

   269

};

   270

   271

enum {

   272

	// These refer to the maximums, so Appalling is -1000 to -400

   273

	// MAXIMUM RATINGS BOUNDARIES

   274

	RATING_MINIMUM     = -1000,

   275

	RATING_APPALLING   =  -400,

   276

	RATING_VERYPOOR    =  -200,

   277

	RATING_POOR        =     0,

   278

	RATING_MEDIOCRE    =   200,

   279

	RATING_GOOD        =   400,

   280

	RATING_VERYGOOD    =   600,

   281

	RATING_EXCELLENT   =   800,

   282

	RATING_OUTSTANDING =  1000,         // OUTSTANDING

   283

   284

	RATING_MAXIMUM = RATING_OUTSTANDING,

   285

   286

	// RATINGS AFFECTING NUMBERS

   287

	RATING_TREE_DOWN_STEP = -35,

   288

	RATING_TREE_MINIMUM   = RATING_MINIMUM,

   289

	RATING_TREE_UP_STEP   = 7,

   290

	RATING_TREE_MAXIMUM   = 220,

   291

   292

	RATING_TUNNEL_BRIDGE_DOWN_STEP = -250,

   293

	RATING_TUNNEL_BRIDGE_MINIMUM   = 0,

   294

   295

	RATING_INDUSTRY_DOWN_STEP = -1500,

   296

	RATING_INDUSTRY_MINIMUM   = RATING_MINIMUM,

   297

   298

	RATING_ROAD_DOWN_STEP = -50,

   299

	RATING_ROAD_MINIMUM   = -100,

   300

	RATING_HOUSE_MINIMUM  = RATING_MINIMUM,

   301

   302

	RATING_BRIBE_UP_STEP = 200,

   303

	RATING_BRIBE_MAXIMUM = 800,

   304

	RATING_BRIBE_DOWN_TO = -50        // XXX SHOULD BE SOMETHING LOWER?

   305

};

   306

   307

enum {

   308

/* This is the base "normal" number of towns on the 8x8 map, when

   309

 * one town should get grown per tick. The other numbers of towns

   310

 * are then scaled based on that. */

   311

	TOWN_GROWTH_FREQUENCY = 23,

   312

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

   313

	TOWN_HOUSE_COMPLETED  =  3,

   314

};

   315

   316

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

   317

 * IT simply states what bit is used for.

   318

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

   319

 * per town, NO MATTER the population of it.

   320

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

   321

 */

   322

enum {

   323

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

   324

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

   325

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

   326

};

   327

   328

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

   329

   330

VARDEF const Town** _town_sort;

   331

   332

DECLARE_OLD_POOL(Town, Town, 3, 8000)

   333

   334

static inline HouseSpec *GetHouseSpecs(HouseID house_id)

   335

{

   336

	assert(house_id < HOUSE_MAX);

   337

	return &_house_specs[house_id];

   338

}

   339

   340

/**

   341

 * Check if a Town really exists.

   342

 */

   343

static inline bool IsValidTown(const Town* town)

   344

{

   345

	return town->xy != 0;

   346

}

   347

   348

static inline bool IsValidTownID(TownID index)

   349

{

   350

	return index < GetTownPoolSize() && IsValidTown(GetTown(index));

   351

}

   352

   353

VARDEF uint _total_towns;

   354

   355

static inline TownID GetMaxTownIndex()

   356

{

   357

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

   358

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

   359

	 *  _really_ returns the highest index. Now it just returns

   360

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

   361

	 */

   362

	return GetTownPoolSize() - 1;

   363

}

   364

   365

static inline uint GetNumTowns()

   366

{

   367

	return _total_towns;

   368

}

   369

   370

/**

   371

 * Return a random valid town.

   372

 */

   373

static inline Town *GetRandomTown()

   374

{

   375

	int num = RandomRange(GetNumTowns());

   376

	TownID index = INVALID_TOWN;

   377

   378

	while (num >= 0) {

   379

		num--;

   380

   381

		index++;

   382

		/* Make sure we have a valid town */

   383

		while (!IsValidTownID(index)) {

   384

			index++;

   385

			assert(index <= GetMaxTownIndex());

   386

		}

   387

	}

   388

   389

	return GetTown(index);

   390

}

   391

   392

void DestroyTown(Town *t);

   393

   394

static inline void DeleteTown(Town *t)

   395

{

   396

	DestroyTown(t);

   397

	t->xy = 0;

   398

}

   399

   400

Town* CalcClosestTownFromTile(TileIndex tile, uint threshold);

   401

   402

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

   403

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

   404

   405

VARDEF bool _town_sort_dirty;

   406

VARDEF byte _town_sort_order;

   407

   408

VARDEF Town *_cleared_town;

   409

VARDEF int _cleared_town_rating;

   410

   411

uint OriginalTileRandomiser(uint x, uint y);

   412

void ResetHouses();

   413

   414

void ClearTownHouse(Town *t, TileIndex tile);

   415

   416

#endif /* TOWN_H */