1

/* $Id$ */

     2

     3

#ifndef PLAYER_H

     4

#define PLAYER_H

     5

     6

#include "aystar.h"

     7

#include "rail.h"

     8

#include "engine.h"

     9

    10

typedef struct PlayerEconomyEntry {

    11

	int32 income;

    12

	int32 expenses;

    13

	int32 delivered_cargo;

    14

	int32 performance_history;	// player score (scale 0-1000)

    15

	int64 company_value;

    16

} PlayerEconomyEntry;

    17

    18

typedef struct AiBuildRec {

    19

	TileIndex spec_tile;

    20

	TileIndex use_tile;

    21

	byte rand_rng;

    22

	byte cur_building_rule;

    23

	byte unk6;

    24

	byte unk7;

    25

	byte buildcmd_a;

    26

	byte buildcmd_b;

    27

	byte direction;

    28

	byte cargo;

    29

} AiBuildRec;

    30

    31

typedef struct PlayerAI {

    32

	byte state;

    33

	byte tick; // Used to determine how often to move

    34

	uint32 state_counter; // Can hold tile index!

    35

	uint16 timeout_counter;

    36

    37

	byte state_mode;

    38

	byte banned_tile_count;

    39

	byte railtype_to_use;

    40

    41

	byte cargo_type;

    42

	byte num_wagons;

    43

	byte build_kind;

    44

	byte num_build_rec;

    45

	byte num_loco_to_build;

    46

	byte num_want_fullload;

    47

    48

	byte route_type_mask;

    49

    50

	TileIndex start_tile_a;

    51

	TileIndex cur_tile_a;

    52

	byte cur_dir_a;

    53

	byte start_dir_a;

    54

    55

	TileIndex start_tile_b;

    56

	TileIndex cur_tile_b;

    57

	byte cur_dir_b;

    58

	byte start_dir_b;

    59

    60

	Vehicle *cur_veh; /* only used by some states */

    61

    62

	AiBuildRec src, dst, mid1, mid2;

    63

    64

	VehicleID wagon_list[9];

    65

	byte order_list_blocks[20];

    66

    67

	TileIndex banned_tiles[16];

    68

	byte banned_val[16];

    69

} PlayerAI;

    70

    71

typedef struct Ai_PathFinderInfo {

    72

	TileIndex start_tile_tl; // tl = top-left

    73

	TileIndex start_tile_br; // br = bottom-right

    74

	TileIndex end_tile_tl; // tl = top-left

    75

	TileIndex end_tile_br; // br = bottom-right

    76

	byte start_direction; // 0 to 3 or AI_PATHFINDER_NO_DIRECTION

    77

	byte end_direction; // 0 to 3 or AI_PATHFINDER_NO_DIRECTION

    78

    79

	TileIndex route[500];

    80

	byte route_extra[500]; // Some extra information about the route like bridge/tunnel

    81

	int route_length;

    82

	int position; // Current position in the build-path, needed to build the path

    83

    84

	bool rail_or_road; // true = rail, false = road

    85

} Ai_PathFinderInfo;

    86

    87

// The amount of memory reserved for the AI-special-vehicles

    88

#define AI_MAX_SPECIAL_VEHICLES 100

    89

    90

typedef struct Ai_SpecialVehicle {

    91

	VehicleID veh_id;

    92

	uint32 flag;

    93

} Ai_SpecialVehicle;

    94

    95

typedef struct PlayerAiNew {

    96

	uint8 state;

    97

	uint tick;

    98

	uint idle;

    99

   100

	int temp; 	// A value used in more than one function, but it just temporary

   101

				// The use is pretty simple: with this we can 'think' about stuff

   102

				//   in more than one tick, and more than one AI. A static will not

   103

				//   do, because they are not saved. This way, the AI is almost human ;)

   104

	int counter; 	// For the same reason as temp, we have counter. It can count how

   105

					//  long we are trying something, and just abort if it takes too long

   106

   107

	// Pathfinder stuff

   108

	Ai_PathFinderInfo path_info;

   109

	AyStar *pathfinder;

   110

   111

	// Route stuff

   112

   113

	byte cargo;

   114

	byte tbt; // train/bus/truck 0/1/2 AI_TRAIN/AI_BUS/AI_TRUCK

   115

	int new_cost;

   116

   117

	byte action;

   118

   119

	int last_id; // here is stored the last id of the searched city/industry

   120

	uint last_vehiclecheck_date; // Used in CheckVehicle

   121

	Ai_SpecialVehicle special_vehicles[AI_MAX_SPECIAL_VEHICLES]; // Some vehicles have some special flags

   122

   123

	TileIndex from_tile;

   124

	TileIndex to_tile;

   125

   126

	byte from_direction;

   127

	byte to_direction;

   128

   129

	bool from_deliver; // True if this is the station that GIVES cargo

   130

	bool to_deliver;

   131

   132

	TileIndex depot_tile;

   133

	byte depot_direction;

   134

   135

	byte amount_veh; // How many vehicles we are going to build in this route

   136

	byte cur_veh; // How many vehicles did we bought?

   137

	VehicleID veh_id; // Used when bought a vehicle

   138

	VehicleID veh_main_id; // The ID of the first vehicle, for shared copy

   139

   140

	int from_ic; // ic = industry/city. This is the ID of them

   141

	byte from_type; // AI_NO_TYPE/AI_CITY/AI_INDUSTRY

   142

	int to_ic;

   143

	byte to_type;

   144

   145

} PlayerAiNew;

   146

   147

   148

   149

typedef struct Player {

   150

	uint32 name_2;

   151

	uint16 name_1;

   152

   153

	uint16 president_name_1;

   154

	uint32 president_name_2;

   155

   156

	uint32 face;

   157

   158

	int32 player_money;

   159

	int32 current_loan;

   160

	int64 money64; // internal 64-bit version of the money. the 32-bit field will be clamped to plus minus 2 billion

   161

   162

	byte player_color;

   163

	byte player_money_fraction;

   164

	byte avail_railtypes;

   165

	byte block_preview;

   166

	PlayerID index;

   167

   168

	uint16 cargo_types; /* which cargo types were transported the last year */

   169

   170

	TileIndex location_of_house;

   171

	TileIndex last_build_coordinate;

   172

   173

	PlayerID share_owners[4];

   174

   175

	byte inaugurated_year;

   176

	byte num_valid_stat_ent;

   177

   178

	byte quarters_of_bankrupcy;

   179

	byte bankrupt_asked; // which players were asked about buying it?

   180

	int16 bankrupt_timeout;

   181

	int32 bankrupt_value;

   182

   183

	bool is_active;

   184

	byte is_ai;

   185

	PlayerAI ai;

   186

	PlayerAiNew ainew;

   187

   188

	int64 yearly_expenses[3][13];

   189

	PlayerEconomyEntry cur_economy;

   190

	PlayerEconomyEntry old_economy[24];

   191

	EngineID engine_replacement[TOTAL_NUM_ENGINES];

   192

	bool engine_renew;

   193

	bool renew_keep_length;

   194

	int16 engine_renew_months;

   195

	uint32 engine_renew_money;

   196

} Player;

   197

   198

void ChangeOwnershipOfPlayerItems(PlayerID old_player, PlayerID new_player);

   199

void GetNameOfOwner(PlayerID owner, TileIndex tile);

   200

int64 CalculateCompanyValue(const Player* p);

   201

void InvalidatePlayerWindows(const Player* p);

   202

void UpdatePlayerMoney32(Player *p);

   203

#define FOR_ALL_PLAYERS(p) for(p=_players; p != endof(_players); p++)

   204

   205

VARDEF PlayerID _local_player;

   206

VARDEF PlayerID _current_player;

   207

   208

#define MAX_PLAYERS 8

   209

VARDEF Player _players[MAX_PLAYERS];

   210

// NOSAVE: can be determined from player structs

   211

VARDEF byte _player_colors[MAX_PLAYERS];

   212

   213

static inline Player* GetPlayer(PlayerID i)

   214

{

   215

	assert(i < lengthof(_players));

   216

	return &_players[i];

   217

}

   218

   219

static inline bool IsLocalPlayer(void)

   220

{

   221

	return _local_player == _current_player;

   222

}

   223

   224

void DeletePlayerWindows(PlayerID pi);

   225

byte GetPlayerRailtypes(PlayerID p);

   226

   227

/** Finds out if a Player has a certain railtype available

   228

  */

   229

static inline bool HasRailtypeAvail(const Player *p, RailType Railtype)

   230

{

   231

	return HASBIT(p->avail_railtypes, Railtype);

   232

}

   233

   234

/* Validate functions for rail building */

   235

static inline bool ValParamRailtype(uint32 rail) { return HASBIT(GetPlayer(_current_player)->avail_railtypes, rail);}

   236

   237

/** Returns the "best" railtype a player can build.

   238

  * As the AI doesn't know what the BEST one is, we

   239

  * have our own priority list here. When adding

   240

  * new railtypes, modify this function

   241

  * @param p the player "in action"

   242

  * @return The "best" railtype a player has available

   243

  */

   244

static inline RailType GetBestRailtype(const Player* p)

   245

{

   246

	if (HasRailtypeAvail(p, RAILTYPE_MAGLEV)) return RAILTYPE_MAGLEV;

   247

	if (HasRailtypeAvail(p, RAILTYPE_MONO)) return RAILTYPE_MONO;

   248

	return RAILTYPE_RAIL;

   249

}

   250

   251

#define IS_HUMAN_PLAYER(p) (!GetPlayer(p)->is_ai)

   252

#define IS_INTERACTIVE_PLAYER(p) ((p) == _local_player)

   253

   254

typedef struct HighScore {

   255

	char company[100];

   256

	StringID title; // NO_SAVE, has troubles with changing string-numbers.

   257

	uint16 score;   // do NOT change type, will break hs.dat

   258

} HighScore;

   259

   260

VARDEF HighScore _highscore_table[5][5]; // 4 difficulty-settings (+ network); top 5

   261

void SaveToHighScore(void);

   262

void LoadFromHighScore(void);

   263

int8 SaveHighScoreValue(const Player *p);

   264

int8 SaveHighScoreValueNetwork(void);

   265

   266

void InitialiseEngineReplacement(Player *p);

   267

EngineID EngineReplacement(const Player *p, EngineID engine);

   268

bool EngineHasReplacement(const Player *p, EngineID engine);

   269

int32 AddEngineReplacement(Player *p, EngineID old_engine, EngineID new_engine, uint32 flags);

   270

int32 RemoveEngineReplacement(Player *p, EngineID engine, uint32 flags);

   271

   272

#endif /* PLAYER_H */