1

/* $Id$ */

     2

     3

/** @file player.h */

     4

     5

#ifndef PLAYER_H

     6

#define PLAYER_H

     7

     8

#include "oldpool.h"

     9

#include "aystar.h"

    10

#include "rail.h"

    11

#include "engine.h"

    12

#include "livery.h"

    13

    14

struct PlayerEconomyEntry {

    17

	int32 delivered_cargo;

    18

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

    20

};

    21

    22

struct AiBuildRec {

    23

	TileIndex spec_tile;

    24

	TileIndex use_tile;

    25

	byte rand_rng;

    26

	byte cur_building_rule;

    27

	byte unk6;

    28

	byte unk7;

    29

	byte buildcmd_a;

    30

	byte buildcmd_b;

    31

	byte direction;

    32

	CargoID cargo;

    33

};

    34

    35

struct PlayerAI {

    36

	byte state;

    37

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

    38

	uint32 state_counter; ///< Can hold tile index!

    39

	uint16 timeout_counter;

    40

    41

	byte state_mode;

    42

	byte banned_tile_count;

    43

	RailTypeByte railtype_to_use;

    44

    45

	CargoID cargo_type;

    46

	byte num_wagons;

    47

	byte build_kind;

    48

	byte num_build_rec;

    49

	byte num_loco_to_build;

    50

	byte num_want_fullload;

    51

    52

	byte route_type_mask;

    53

    54

	TileIndex start_tile_a;

    55

	TileIndex cur_tile_a;

    56

	byte cur_dir_a;

    57

	byte start_dir_a;

    58

    59

	TileIndex start_tile_b;

    60

	TileIndex cur_tile_b;

    61

	byte cur_dir_b;

    62

	byte start_dir_b;

    63

    64

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

    65

    66

	AiBuildRec src, dst, mid1, mid2;

    67

    68

	VehicleID wagon_list[9];

    69

	byte order_list_blocks[20];

    70

    71

	TileIndex banned_tiles[16];

    72

	byte banned_val[16];

    73

};

    74

    75

struct Ai_PathFinderInfo {

    76

	TileIndex start_tile_tl; ///< tl = top-left

    77

	TileIndex start_tile_br; ///< br = bottom-right

    78

	TileIndex end_tile_tl;   ///< tl = top-left

    79

	TileIndex end_tile_br;   ///< br = bottom-right

    80

	byte start_direction;    ///< 0 to 3 or AI_PATHFINDER_NO_DIRECTION

    81

	byte end_direction;      ///< 0 to 3 or AI_PATHFINDER_NO_DIRECTION

    82

    83

	TileIndex route[500];

    84

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

    85

	int route_length;

    86

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

    87

    88

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

    89

};

    90

    91

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

    92

#define AI_MAX_SPECIAL_VEHICLES 100

    93

    94

struct Ai_SpecialVehicle {

    95

	VehicleID veh_id;

    96

	uint32 flag;

    97

};

    98

    99

struct PlayerAiNew {

   100

	uint8 state;

   101

	uint tick;

   102

	uint idle;

   103

   104

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

   105

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

   106

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

   107

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

   108

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

   109

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

   110

   111

	/* Pathfinder stuff */

   112

	Ai_PathFinderInfo path_info;

   113

	AyStar *pathfinder;

   114

   115

	/* Route stuff */

   116

   117

	CargoID cargo;

   118

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

   120

   121

	byte action;

   122

   123

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

   124

	Date last_vehiclecheck_date; // Used in CheckVehicle

   125

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

   126

   127

	TileIndex from_tile;

   128

	TileIndex to_tile;

   129

   130

	byte from_direction;

   131

	byte to_direction;

   132

   133

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

   134

	bool to_deliver;

   135

   136

	TileIndex depot_tile;

   137

	DiagDirectionByte depot_direction;

   138

   139

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

   140

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

   141

	VehicleID veh_id;      ///< Used when bought a vehicle

   142

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

   143

   144

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

   145

	byte from_type;        ///< AI_NO_TYPE/AI_CITY/AI_INDUSTRY

   146

	int to_ic;

   147

	byte to_type;

   148

   149

};

   150

   151

   158

typedef uint32 PlayerFace;

   159

   160

struct Player {

   161

	uint32 name_2;

   162

	uint16 name_1;

   163

   164

	uint16 president_name_1;

   165

	uint32 president_name_2;

   166

   167

	PlayerFace face;

   168

   171

   172

	byte player_color;

   173

	Livery livery[LS_END];

   174

	byte player_money_fraction;

   175

	byte avail_railtypes;

   176

	byte avail_roadtypes;

   177

	byte block_preview;

   178

	PlayerByte index;

   179

   180

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

   181

   182

	TileIndex location_of_house;

   183

	TileIndex last_build_coordinate;

   184

   185

	PlayerByte share_owners[4];

   186

   187

	Year inaugurated_year;

   188

	byte num_valid_stat_ent;

   189

   190

	byte quarters_of_bankrupcy;

   191

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

   192

	int16 bankrupt_timeout;

   194

   195

	bool is_active;

   196

	bool is_ai;

   197

	PlayerAI ai;

   198

	PlayerAiNew ainew;

   199

   201

	PlayerEconomyEntry cur_economy;

   202

	PlayerEconomyEntry old_economy[24];

   203

	EngineRenewList engine_renew_list; ///< Defined later

   204

	bool engine_renew;

   205

	bool renew_keep_length;

   206

	int16 engine_renew_months;

   207

	uint32 engine_renew_money;

   208

	uint16 num_engines[TOTAL_NUM_ENGINES]; ///< caches the number of engines of each type the player owns (no need to save this)

   209

};

   210

   211

uint16 GetDrawStringPlayerColor(PlayerID player);

   212

   213

void ChangeOwnershipOfPlayerItems(PlayerID old_player, PlayerID new_player);

   214

void GetNameOfOwner(Owner owner, TileIndex tile);

   216

void InvalidatePlayerWindows(const Player* p);

   217

void SetLocalPlayer(PlayerID new_player);

   218

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

   219

   220

VARDEF PlayerID _local_player;

   221

VARDEF PlayerID _current_player;

   222

   223

VARDEF Player _players[MAX_PLAYERS];

   224

/* NOSAVE: can be determined from player structs */

   225

VARDEF byte _player_colors[MAX_PLAYERS];

   226

   227

static inline byte ActivePlayerCount()

   228

{

   229

	const Player *p;

   230

	byte count = 0;

   231

   232

	FOR_ALL_PLAYERS(p) {

   233

		if (p->is_active) count++;

   234

	}

   235

   236

	return count;

   237

}

   238

   239

static inline Player* GetPlayer(PlayerID i)

   240

{

   241

	assert(IS_INSIDE_1D(i, PLAYER_FIRST, lengthof(_players)));

   242

	return &_players[i];

   243

}

   244

   245

static inline bool IsLocalPlayer()

   246

{

   247

	return _local_player == _current_player;

   248

}

   249

   250

static inline bool IsValidPlayer(PlayerID pi)

   251

{

   252

	return IS_INSIDE_1D(pi, PLAYER_FIRST, MAX_PLAYERS);

   253

}

   254

   255

byte GetPlayerRailtypes(PlayerID p);

   256

byte GetPlayerRoadtypes(PlayerID p);

   257

   258

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

   259

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

   260

{

   261

	return HASBIT(p->avail_railtypes, Railtype);

   262

}

   263

   264

static inline bool IsHumanPlayer(PlayerID pi)

   265

{

   266

	return !GetPlayer(pi)->is_ai;

   267

}

   268

   269

static inline bool IsInteractivePlayer(PlayerID pi)

   270

{

   271

	return pi == _local_player;

   272

}

   273

   274

void DrawPlayerIcon(PlayerID p, int x, int y);

   275

   276

/* Validate functions for rail building */

   277

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

   278

   279

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

   280

 * As the AI doesn't know what the BEST one is, we have our own priority list

   281

 * here. When adding new railtypes, modify this function

   282

 * @param p the player "in action"

   283

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

   284

 */

   285

static inline RailType GetBestRailtype(const Player* p)

   286

{

   287

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

   288

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

   289

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

   290

	return RAILTYPE_RAIL;

   291

}

   292

   293

struct HighScore {

   294

	char company[100];

   295

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

   296

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

   297

};

   298

   299

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

   300

void SaveToHighScore();

   301

void LoadFromHighScore();

   302

int8 SaveHighScoreValue(const Player *p);

   303

int8 SaveHighScoreValueNetwork();

   304

   305

/* Engine Replacement Functions */

   306

   307

/**

   308

 * Remove all engine replacement settings for the given player.

   309

 * @param p Player.

   310

 */

   311

static inline void RemoveAllEngineReplacementForPlayer(Player *p) { RemoveAllEngineReplacement(&p->engine_renew_list); }

   312

   313

/**

   314

 * Retrieve the engine replacement for the given player and original engine type.

   315

 * @param p Player.

   316

 * @param engine Engine type.

   317

 * @return The engine type to replace with, or INVALID_ENGINE if no

   318

 * replacement is in the list.

   319

 */

   320

static inline EngineID EngineReplacementForPlayer(const Player *p, EngineID engine, GroupID group) { return EngineReplacement(p->engine_renew_list, engine, group); }

   321

   322

/**

   323

 * Check if a player has a replacement set up for the given engine.

   324

 * @param p Player.

   325

 * @param  engine Engine type to be replaced.

   326

 * @return true if a replacement was set up, false otherwise.

   327

 */

   328

static inline bool EngineHasReplacementForPlayer(const Player *p, EngineID engine, GroupID group) { return EngineReplacementForPlayer(p, engine, group) != INVALID_ENGINE; }

   329

   330

/**

   331

 * Add an engine replacement for the player.

   332

 * @param p Player.

   333

 * @param old_engine The original engine type.

   334

 * @param new_engine The replacement engine type.

   335

 * @param flags The calling command flags.

   336

 * @return 0 on success, CMD_ERROR on failure.

   337

 */

   339

   340

/**

   341

 * Remove an engine replacement for the player.

   342

 * @param p Player.

   343

 * @param engine The original engine type.

   344

 * @param flags The calling command flags.

   345

 * @return 0 on success, CMD_ERROR on failure.

   346

 */

   348

   349

/**

   350

 * Reset the livery schemes to the player's primary colour.

   351

 * This is used on loading games without livery information and on new player start up.

   352

 * @param p Player to reset.

   353

 */

   354

void ResetPlayerLivery(Player *p);

   355

   356

#endif /* PLAYER_H */