1

#ifndef TOWN_H

     2

#define TOWN_H

     3

     4

#include "pool.h"

     5

#include "player.h"

     6

     7

struct Town {

     8

	TileIndex xy;

     9

    10

	// Current population of people and amount of houses.

    11

	uint16 num_houses;

    12

	uint32 population;

    13

    14

	// Town name

    15

	uint16 townnametype;

    16

	uint32 townnameparts;

    17

    18

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

    19

	ViewportSign sign;

    20

    21

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

    22

	byte flags12;

    23

    24

	// Which players have a statue?

    25

	byte statues;

    26

    27

	// Sort index in listings

    28

	byte sort_index_obsolete;

    29

    30

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

    31

	byte have_ratings;

    32

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

    33

	uint8 exclusivity;	     // which player has exslusivity

    34

	uint8 exclusive_counter;     // months till the exclusivity expires

    35

	int16 ratings[MAX_PLAYERS];

    36

    37

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

    38

	uint32 max_pass;

    39

	uint32 max_mail;

    40

	uint32 new_max_pass;

    41

	uint32 new_max_mail;

    42

	uint32 act_pass;

    43

	uint32 act_mail;

    44

	uint32 new_act_pass;

    45

	uint32 new_act_mail;

    46

    47

	// Amount of passengers that were transported.

    48

	byte pct_pass_transported;

    49

	byte pct_mail_transported;

    50

    51

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

    52

	uint16 act_food;

    53

	uint16 act_water;

    54

	uint16 new_act_food;

    55

	uint16 new_act_water;

    56

    57

	// Time until we rebuild a house.

    58

	byte time_until_rebuild;

    59

    60

	// When to grow town next time.

    61

	byte grow_counter;

    62

	byte growth_rate;

    63

    64

	// Fund buildings program in action?

    65

	byte fund_buildings_months;

    66

    67

	// Fund road reconstruction in action?

    68

	byte road_build_months;

    69

    70

	// Index in town array

    71

	uint16 index;

    72

    73

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

    74

	uint16 radius[5];

    75

};

    76

    77

uint32 GetWorldPopulation(void);

    78

    79

void UpdateTownVirtCoord(Town *t);

    80

void InitializeTown(void);

    81

void ShowTownViewWindow(uint town);

    82

void DeleteTown(Town *t);

    83

void ExpandTown(Town *t);

    84

bool GrowTown(Town *t);

    85

Town *CreateRandomTown(uint attempts);

    86

    87

enum {

    88

	ROAD_REMOVE = 0,

    89

	UNMOVEABLE_REMOVE = 1,

    90

	TUNNELBRIDGE_REMOVE = 1,

    91

	INDUSTRY_REMOVE = 2

    92

};

    93

    94

enum {

    95

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

    96

	// MAXIMUM RATINGS BOUNDARIES

    97

	RATING_MINIMUM 		= -1000,

    98

	RATING_APPALLING 	= -400,

    99

	RATING_VERYPOOR 	= -200,

   100

	RATING_POOR 			= 0,

   101

	RATING_MEDIOCRE		= 200,

   102

	RATING_GOOD				= 400,

   103

	RATING_VERYGOOD		= 600,

   104

	RATING_EXCELLENT	= 800,

   105

	RATING_OUTSTANDING= 1000, 	// OUTSTANDING

   106

   107

	RATING_MAXIMUM = RATING_OUTSTANDING,

   108

   109

	// RATINGS AFFECTING NUMBERS

   110

	RATING_TREE_DOWN_STEP = -35,

   111

	RATING_TREE_MINIMUM = RATING_MINIMUM,

   112

	RATING_TREE_UP_STEP = 7,

   113

	RATING_TREE_MAXIMUM = 220,

   114

   115

	RATING_TUNNEL_BRIDGE_DOWN_STEP = -250,

   116

	RATING_TUNNEL_BRIDGE_MINIMUM = 0,

   117

   118

	RATING_INDUSTRY_DOWN_STEP = -1500,

   119

	RATING_INDUSTRY_MINIMUM = RATING_MINIMUM,

   120

   121

	RATING_ROAD_DOWN_STEP = -50,

   122

	RATING_ROAD_MINIMUM = -100,

   123

	RATING_HOUSE_MINIMUM = RATING_MINIMUM,

   124

   125

	RATING_BRIBE_UP_STEP = 200,

   126

	RATING_BRIBE_MAXIMUM = 800,

   127

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

   128

};

   129

   130

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

   131

   132

VARDEF uint16 *_town_sort;

   133

   134

extern MemoryPool _town_pool;

   135

   136

/**

   137

 * Check if a Town really exists.

   138

 */

   139

static inline bool IsValidTown(Town* town)

   140

{

   141

	return town->xy != 0; /* XXX: Replace by INVALID_TILE someday */

   142

}

   143

   144

/**

   145

 * Get the pointer to the town with index 'index'

   146

 */

   147

static inline Town *GetTown(uint index)

   148

{

   149

	return (Town*)GetItemFromPool(&_town_pool, index);

   150

}

   151

   152

/**

   153

 * Get the current size of the TownPool

   154

 */

   155

static inline uint16 GetTownPoolSize(void)

   156

{

   157

	return _town_pool.total_items;

   158

}

   159

   160

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

   161

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

   162

   163

VARDEF uint _total_towns; // For the AI: the amount of towns active

   164

   165

VARDEF bool _town_sort_dirty;

   166

VARDEF byte _town_sort_order;

   167

   168

VARDEF Town *_cleared_town;

   169

VARDEF int _cleared_town_rating;

   170

   171

#endif /* TOWN_H */