1

/* $Id$ */

     2

     3

/** @file town.h */

     4

     5

#ifndef TOWN_H

     6

#define TOWN_H

     7

     8

#include "oldpool.h"

     9

#include "player.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;

    79

DECLARE_OLD_POOL(Town, Town, 3, 8000)

    80

    81

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

    82

	TileIndex xy;

    83

    84

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

    85

	uint16 num_houses;

    86

	uint32 population;

    87

    88

	/* Town name */

    89

	uint32 townnamegrfid;

    90

	uint16 townnametype;

    91

	uint32 townnameparts;

    92

    93

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

    94

	ViewportSign sign;

    95

    96

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

    97

	 * bit 0 = Building funds received

    98

	 * bit 1 = CHURCH

    99

	 * bit 2 = STADIUM */

   100

	byte flags12;

   101

   102

	/* Which players have a statue? */

   103

	byte statues;

   104

   105

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

   106

	byte have_ratings;

   107

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

   108

	PlayerByte exclusivity;      ///< which player has exslusivity

   109

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

   110

	int16 ratings[MAX_PLAYERS];

   111

   112

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

   113

	uint32 max_pass;

   114

	uint32 max_mail;

   115

	uint32 new_max_pass;

   116

	uint32 new_max_mail;

   117

	uint32 act_pass;

   118

	uint32 act_mail;

   119

	uint32 new_act_pass;

   120

	uint32 new_act_mail;

   121

   122

	/* Amount of passengers that were transported. */

   123

	byte pct_pass_transported;

   124

	byte pct_mail_transported;

   125

   126

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

   127

	uint16 act_food;

   128

	uint16 act_water;

   129

	uint16 new_act_food;

   130

	uint16 new_act_water;

   131

   132

	/* Time until we rebuild a house. */

   133

	uint16 time_until_rebuild;

   134

   135

	/* When to grow town next time. */

   136

	uint16 grow_counter;

   137

	int16 growth_rate;

   138

   139

	/* Fund buildings program in action? */

   140

	byte fund_buildings_months;

   141

   142

	/* Fund road reconstruction in action? */

   143

	byte road_build_months;

   144

   145

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

   146

	bool larger_town;

   147

   148

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

   149

	uint16 radius[5];

   150

   151

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

   152

	BuildingCounts building_counts;

   153

   154

	/**

   155

	 * Creates a new town

   156

	 */

   157

	Town(TileIndex tile = 0);

   158

   159

	/** Destroy the town */

   160

	~Town();

   161

   162

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

   163

};

   164

   165

struct HouseSpec {

   166

	/* Standard properties */

   167

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

   168

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

   169

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

   170

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

   171

	StringID building_name;            ///< building name

   172

	uint16 remove_rating_decrease;     ///< rating decrease if removed

   173

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

   174

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

   175

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

   176

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

   177

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

   178

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

   179

   180

	/* NewHouses properties */

   181

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

   182

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

   183

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

   184

	uint16 callback_mask;              ///< House callback flags

   185

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

   186

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

   187

	HouseExtraFlags extra_flags;       ///< some more flags

   188

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

   189

	byte animation_frames;             ///< number of animation frames

   190

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

   191

	byte processing_time;              ///< Periodic refresh multiplier

   192

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

   193

   194

	/* grf file related properties*/

   195

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

   196

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

   197

};

   198

   199

enum TownSizeMode {

   200

	TSM_RANDOM,

   201

	TSM_FIXED,

   202

	TSM_CITY

   203

};

   204

   205

VARDEF HouseSpec _house_specs[HOUSE_MAX];

   206

   207

uint32 GetWorldPopulation();

   208

   209

void UpdateTownVirtCoord(Town *t);

   210

void InitializeTown();

   211

void ShowTownViewWindow(TownID town);

   212

void ExpandTown(Town *t);

   213

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

   214

   215

enum {

   216

	ROAD_REMOVE = 0,

   217

	UNMOVEABLE_REMOVE = 1,

   218

	TUNNELBRIDGE_REMOVE = 1,

   219

	INDUSTRY_REMOVE = 2

   220

};

   221

   222

enum {

   223

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

   224

	 * MAXIMUM RATINGS BOUNDARIES */

   225

	RATING_MINIMUM     = -1000,

   226

	RATING_APPALLING   =  -400,

   227

	RATING_VERYPOOR    =  -200,

   228

	RATING_POOR        =     0,

   229

	RATING_MEDIOCRE    =   200,

   230

	RATING_GOOD        =   400,

   231

	RATING_VERYGOOD    =   600,

   232

	RATING_EXCELLENT   =   800,

   233

	RATING_OUTSTANDING =  1000,         ///< OUTSTANDING

   234

   235

	RATING_MAXIMUM = RATING_OUTSTANDING,

   236

   237

	/* RATINGS AFFECTING NUMBERS */

   238

	RATING_TREE_DOWN_STEP = -35,

   239

	RATING_TREE_MINIMUM   = RATING_MINIMUM,

   240

	RATING_TREE_UP_STEP   = 7,

   241

	RATING_TREE_MAXIMUM   = 220,

   242

   243

	RATING_TUNNEL_BRIDGE_DOWN_STEP = -250,

   244

	RATING_TUNNEL_BRIDGE_MINIMUM   = 0,

   245

   246

	RATING_INDUSTRY_DOWN_STEP = -1500,

   247

	RATING_INDUSTRY_MINIMUM   = RATING_MINIMUM,

   248

   249

	RATING_ROAD_DOWN_STEP = -50,

   250

	RATING_ROAD_MINIMUM   = -100,

   251

	RATING_HOUSE_MINIMUM  = RATING_MINIMUM,

   252

   253

	RATING_BRIBE_UP_STEP = 200,

   254

	RATING_BRIBE_MAXIMUM = 800,

   255

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

   256

};

   257

   258

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

   259

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

   260

 * in TTD. */

   261

static const byte TOWN_GROWTH_FREQUENCY = 70;

   262

   263

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

   264

 * construction. */

   265

static const byte TOWN_HOUSE_COMPLETED = 3;

   266

   267

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

   268

 * IT simply states what bit is used for.

   269

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

   270

 * per town, NO MATTER the population of it.

   271

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

   272

 */

   273

enum {

   274

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

   275

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

   276

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

   277

};

   278

   279

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

   280

   281

VARDEF const Town** _town_sort;

   282

   283

static inline HouseSpec *GetHouseSpecs(HouseID house_id)

   284

{

   285

	assert(house_id < HOUSE_MAX);

   286

	return &_house_specs[house_id];

   287

}

   288

   289

/**

   290

 * Check if a TownID is valid.

   291

 * @param index to inquiry in the pool of town

   292

 * @return true if it exists

   293

 */

   294

static inline bool IsValidTownID(TownID index)

   295

{

   296

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

   297

}

   298

   299

VARDEF uint _total_towns;

   300

   301

static inline TownID GetMaxTownIndex()

   302

{

   303

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

   304

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

   305

	 *  _really_ returns the highest index. Now it just returns

   306

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

   307

	 */

   308

	return GetTownPoolSize() - 1;

   309

}

   310

   311

static inline uint GetNumTowns()

   312

{

   313

	return _total_towns;

   314

}

   315

   316

/**

   317

 * Return a random valid town.

   318

 */

   319

static inline Town *GetRandomTown()

   320

{

   321

	int num = RandomRange(GetNumTowns());

   322

	TownID index = INVALID_TOWN;

   323

   324

	while (num >= 0) {

   325

		num--;

   326

   327

		index++;

   328

		/* Make sure we have a valid town */

   329

		while (!IsValidTownID(index)) {

   330

			index++;

   331

			assert(index <= GetMaxTownIndex());

   332

		}

   333

	}

   334

   335

	return GetTown(index);

   336

}

   337

   338

Town* CalcClosestTownFromTile(TileIndex tile, uint threshold);

   339

   340

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

   341

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

   342

   343

VARDEF bool _town_sort_dirty;

   344

VARDEF byte _town_sort_order;

   345

   346

VARDEF Town *_cleared_town;

   347

VARDEF int _cleared_town_rating;

   348

   349

uint OriginalTileRandomiser(uint x, uint y);

   350

void ResetHouses();

   351

   352

void ClearTownHouse(Town *t, TileIndex tile);

   353

   354

#endif /* TOWN_H */