1

/* $Id$ */

     2

     3

#ifndef TOWN_H

     4

#define TOWN_H

     5

     6

#include "oldpool.h"

     7

#include "player.h"

     8

     9

enum {

    10

	INVALID_TOWN = 0xFFFF,

    11

};

    12

    13

struct Town {

    14

	TileIndex xy;

    15

    16

	// Current population of people and amount of houses.

    17

	uint16 num_houses;

    18

	uint32 population;

    19

    20

	// Town name

    21

	uint16 townnametype;

    22

	uint32 townnameparts;

    23

    24

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

    25

	ViewportSign sign;

    26

    27

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

    28

	// bit 0 = Building funds received

    29

	// bit 1 = CHURCH

    30

	// bit 2 = STADIUM

    31

	byte flags12;

    32

    33

	// Which players have a statue?

    34

	byte statues;

    35

    36

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

    37

	byte have_ratings;

    38

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

    39

	PlayerID exclusivity;        // which player has exslusivity

    40

	uint8 exclusive_counter;     // months till the exclusivity expires

    41

	int16 ratings[MAX_PLAYERS];

    42

    43

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

    44

	uint32 max_pass;

    45

	uint32 max_mail;

    46

	uint32 new_max_pass;

    47

	uint32 new_max_mail;

    48

	uint32 act_pass;

    49

	uint32 act_mail;

    50

	uint32 new_act_pass;

    51

	uint32 new_act_mail;

    52

    53

	// Amount of passengers that were transported.

    54

	byte pct_pass_transported;

    55

	byte pct_mail_transported;

    56

    57

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

    58

	uint16 act_food;

    59

	uint16 act_water;

    60

	uint16 new_act_food;

    61

	uint16 new_act_water;

    62

    63

	// Time until we rebuild a house.

    64

	byte time_until_rebuild;

    65

    66

	// When to grow town next time.

    67

	byte grow_counter;

    68

	byte growth_rate;

    69

    70

	// Fund buildings program in action?

    71

	byte fund_buildings_months;

    72

    73

	// Fund road reconstruction in action?

    74

	byte road_build_months;

    75

    76

	// Index in town array

    77

	TownID index;

    78

    79

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

    80

	uint16 radius[5];

    81

};

    82

    83

uint32 GetWorldPopulation(void);

    84

    85

void UpdateTownVirtCoord(Town *t);

    86

void InitializeTown(void);

    87

void ShowTownViewWindow(TownID town);

    88

void ExpandTown(Town *t);

    89

Town *CreateRandomTown(uint attempts, uint size_mode);

    90

    91

enum {

    92

	ROAD_REMOVE = 0,

    93

	UNMOVEABLE_REMOVE = 1,

    94

	TUNNELBRIDGE_REMOVE = 1,

    95

	INDUSTRY_REMOVE = 2

    96

};

    97

    98

enum {

    99

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

   100

	// MAXIMUM RATINGS BOUNDARIES

   101

	RATING_MINIMUM     = -1000,

   102

	RATING_APPALLING   =  -400,

   103

	RATING_VERYPOOR    =  -200,

   104

	RATING_POOR        =     0,

   105

	RATING_MEDIOCRE    =   200,

   106

	RATING_GOOD        =   400,

   107

	RATING_VERYGOOD    =   600,

   108

	RATING_EXCELLENT   =   800,

   109

	RATING_OUTSTANDING =  1000,         // OUTSTANDING

   110

   111

	RATING_MAXIMUM = RATING_OUTSTANDING,

   112

   113

	// RATINGS AFFECTING NUMBERS

   114

	RATING_TREE_DOWN_STEP = -35,

   115

	RATING_TREE_MINIMUM   = RATING_MINIMUM,

   116

	RATING_TREE_UP_STEP   = 7,

   117

	RATING_TREE_MAXIMUM   = 220,

   118

   119

	RATING_TUNNEL_BRIDGE_DOWN_STEP = -250,

   120

	RATING_TUNNEL_BRIDGE_MINIMUM   = 0,

   121

   122

	RATING_INDUSTRY_DOWN_STEP = -1500,

   123

	RATING_INDUSTRY_MINIMUM   = RATING_MINIMUM,

   124

   125

	RATING_ROAD_DOWN_STEP = -50,

   126

	RATING_ROAD_MINIMUM   = -100,

   127

	RATING_HOUSE_MINIMUM  = RATING_MINIMUM,

   128

   129

	RATING_BRIBE_UP_STEP = 200,

   130

	RATING_BRIBE_MAXIMUM = 800,

   131

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

   132

};

   133

   134

enum {

   135

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

   136

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

   137

 * are then scaled based on that. */

   138

	TOWN_GROWTH_FREQUENCY = 23,

   139

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

   140

	TOWN_HOUSE_COMPLETED  =  3,

   141

};

   142

   143

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

   144

 * IT simply states what bit is used for.

   145

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

   146

 * per town, NO MATTER the population of it.

   147

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

   148

 */

   149

enum {

   150

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

   151

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

   152

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

   153

};

   154

   155

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

   156

   157

VARDEF const Town** _town_sort;

   158

   159

DECLARE_OLD_POOL(Town, Town, 3, 8000)

   160

   161

/**

   162

 * Check if a Town really exists.

   163

 */

   164

static inline bool IsValidTown(const Town* town)

   165

{

   166

	return town->xy != 0;

   167

}

   168

   169

static inline bool IsValidTownID(TownID index)

   170

{

   171

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

   172

}

   173

   174

VARDEF uint _total_towns;

   175

   176

static inline TownID GetMaxTownIndex(void)

   177

{

   178

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

   179

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

   180

	 *  _really_ returns the highest index. Now it just returns

   181

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

   182

	 */

   183

	return GetTownPoolSize() - 1;

   184

}

   185

   186

static inline uint GetNumTowns(void)

   187

{

   188

	return _total_towns;

   189

}

   190

   191

/**

   192

 * Return a random valid town.

   193

 */

   194

static inline Town *GetRandomTown(void)

   195

{

   196

	int num = RandomRange(GetNumTowns());

   197

	TownID index = INVALID_TOWN;

   198

   199

	while (num >= 0) {

   200

		num--;

   201

   202

		index++;

   203

		/* Make sure we have a valid industry */

   204

		while (!IsValidTownID(index)) {

   205

			index++;

   206

			assert(index <= GetMaxTownIndex());

   207

		}

   208

	}

   209

   210

	return GetTown(index);

   211

}

   212

   213

void DestroyTown(Town *t);

   214

   215

static inline void DeleteTown(Town *t)

   216

{

   217

	DestroyTown(t);

   218

	t->xy = 0;

   219

}

   220

   221

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

   222

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

   223

   224

VARDEF bool _town_sort_dirty;

   225

VARDEF byte _town_sort_order;

   226

   227

VARDEF Town *_cleared_town;

   228

VARDEF int _cleared_town_rating;

   229

   230

#endif /* TOWN_H */