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_type.h"

    11

#include "road_func.h"

    14

#include "engine.h"

    15

#include "livery.h"

    16

#include "genworld.h"

    17

#include "gfx.h"

    18

    19

struct PlayerEconomyEntry {

    20

	Money income;

    21

	Money expenses;

    22

	int32 delivered_cargo;

    23

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

    24

	Money company_value;

    25

};

    26

    27

struct AiBuildRec {

    28

	TileIndex spec_tile;

    29

	TileIndex use_tile;

    30

	byte rand_rng;

    31

	byte cur_building_rule;

    32

	byte unk6;

    33

	byte unk7;

    34

	byte buildcmd_a;

    35

	byte buildcmd_b;

    36

	byte direction;

    37

	CargoID cargo;

    38

};

    39

    40

struct PlayerAI {

    41

	byte state;

    42

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

    43

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

    44

	uint16 timeout_counter;

    45

    46

	byte state_mode;

    47

	byte banned_tile_count;

    48

	RailTypeByte railtype_to_use;

    49

    50

	CargoID cargo_type;

    51

	byte num_wagons;

    52

	byte build_kind;

    53

	byte num_build_rec;

    54

	byte num_loco_to_build;

    55

	byte num_want_fullload;

    56

    57

	byte route_type_mask;

    58

    59

	TileIndex start_tile_a;

    60

	TileIndex cur_tile_a;

    61

	DiagDirectionByte cur_dir_a;

    62

	DiagDirectionByte start_dir_a;

    63

    64

	TileIndex start_tile_b;

    65

	TileIndex cur_tile_b;

    66

	DiagDirectionByte cur_dir_b;

    67

	DiagDirectionByte start_dir_b;

    68

    69

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

    70

    71

	AiBuildRec src, dst, mid1, mid2;

    72

    73

	VehicleID wagon_list[9];

    74

	byte order_list_blocks[20];

    75

    76

	TileIndex banned_tiles[16];

    77

	byte banned_val[16];

    78

};

    79

    80

struct Ai_PathFinderInfo {

    81

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

    82

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

    83

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

    84

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

    85

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

    86

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

    87

    88

	TileIndex route[500];

    89

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

    90

	int route_length;

    91

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

    92

    93

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

    94

};

    95

    96

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

    97

#define AI_MAX_SPECIAL_VEHICLES 100

    98

    99

struct Ai_SpecialVehicle {

   100

	VehicleID veh_id;

   101

	uint32 flag;

   102

};

   103

   104

struct PlayerAiNew {

   105

	uint8 state;

   106

	uint tick;

   107

	uint idle;

   108

   109

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

   110

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

   111

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

   112

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

   113

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

   114

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

   115

   116

	/* Pathfinder stuff */

   117

	Ai_PathFinderInfo path_info;

   118

	AyStar *pathfinder;

   119

   120

	/* Route stuff */

   121

   122

	CargoID cargo;

   123

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

   124

	Money new_cost;

   125

   126

	byte action;

   127

   128

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

   129

	Date last_vehiclecheck_date; // Used in CheckVehicle

   130

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

   131

   132

	TileIndex from_tile;

   133

	TileIndex to_tile;

   134

   135

	DiagDirectionByte from_direction;

   136

	DiagDirectionByte to_direction;

   137

   138

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

   139

	bool to_deliver;

   140

   141

	TileIndex depot_tile;

   142

	DiagDirectionByte depot_direction;

   143

   144

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

   145

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

   146

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

   147

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

   148

   149

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

   150

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

   151

	int to_ic;

   152

	byte to_type;

   153

   154

};

   155

   156

   157

/* The "steps" in loan size, in British Pounds! */

   158

enum {

   159

	LOAN_INTERVAL        = 10000,

   160

	LOAN_INTERVAL_OLD_AI = 50000,

   161

};

   162

   163

struct Player {

   164

	uint32 name_2;

   165

	uint16 name_1;

   166

   167

	uint16 president_name_1;

   168

	uint32 president_name_2;

   169

   170

	PlayerFace face;

   171

   172

	Money player_money;

   173

	Money current_loan;

   174

   175

	byte player_color;

   176

	Livery livery[LS_END];

   177

	byte player_money_fraction;

   178

	byte avail_railtypes;

   179

	byte avail_roadtypes;

   180

	byte block_preview;

   181

	PlayerByte index;

   182

   183

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

   184

   185

	TileIndex location_of_house;

   186

	TileIndex last_build_coordinate;

   187

   188

	PlayerByte share_owners[4];

   189

   190

	Year inaugurated_year;

   191

	byte num_valid_stat_ent;

   192

   193

	byte quarters_of_bankrupcy;

   194

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

   195

	int16 bankrupt_timeout;

   196

	Money bankrupt_value;

   197

   198

	bool is_active;

   199

	bool is_ai;

   200

	PlayerAI ai;

   201

	PlayerAiNew ainew;

   202

   203

	Money yearly_expenses[3][13];

   204

	PlayerEconomyEntry cur_economy;

   205

	PlayerEconomyEntry old_economy[24];

   206

	EngineRenewList engine_renew_list; ///< Defined later

   207

	bool engine_renew;

   208

	bool renew_keep_length;

   209

	int16 engine_renew_months;

   210

	uint32 engine_renew_money;

   211

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

   212

};

   213

   214

uint16 GetDrawStringPlayerColor(PlayerID player);

   215

   216

void ChangeOwnershipOfPlayerItems(PlayerID old_player, PlayerID new_player);

   217

void GetNameOfOwner(Owner owner, TileIndex tile);

   218

Money CalculateCompanyValue(const Player *p);

   219

void InvalidatePlayerWindows(const Player *p);

   220

void SetLocalPlayer(PlayerID new_player);

   221

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

   222

   223

VARDEF PlayerByte _local_player;

   224

VARDEF PlayerByte _current_player;

   225

   226

VARDEF Player _players[MAX_PLAYERS];

   227

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

   228

VARDEF byte _player_colors[MAX_PLAYERS];

   229

   230

static inline byte ActivePlayerCount()

   231

{

   232

	const Player *p;

   233

	byte count = 0;

   234

   235

	FOR_ALL_PLAYERS(p) {

   236

		if (p->is_active) count++;

   237

	}

   238

   239

	return count;

   240

}

   241

   242

static inline Player *GetPlayer(PlayerID i)

   243

{

   244

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

   245

	return &_players[i];

   246

}

   247

   248

static inline bool IsLocalPlayer()

   249

{

   250

	return _local_player == _current_player;

   251

}

   252

   253

static inline bool IsValidPlayer(PlayerID pi)

   254

{

   255

	return IsInsideBS(pi, PLAYER_FIRST, MAX_PLAYERS);

   256

}

   257

   258

byte GetPlayerRailtypes(PlayerID p);

   259

byte GetPlayerRoadtypes(PlayerID p);

   260

   261

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

   262

 * @param p Player in question

   263

 * @param Railtype requested RailType

   264

 * @return true if player has requested RailType available

   265

 */

   266

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

   267

{

   268

	return HasBit(p->avail_railtypes, Railtype);

   269

}

   270

   271

/** Finds out, whether given player has all given RoadTypes available

   272

 * @param PlayerID ID of player

   273

 * @param rts RoadTypes to test

   274

 * @return true if player has all requested RoadTypes available

   275

 */

   276

static inline bool HasRoadTypesAvail(const PlayerID p, const RoadTypes rts)

   277

{

   278

	RoadTypes avail_roadtypes;

   279

   280

	if (p == OWNER_TOWN || _game_mode == GM_EDITOR || IsGeneratingWorld()) {

   281

		avail_roadtypes = ROADTYPES_ROAD;

   282

	} else {

   283

		if (!IsValidPlayer(p)) return false;

   284

		avail_roadtypes = (RoadTypes)GetPlayer(p)->avail_roadtypes | ROADTYPES_ROAD; // road is available for always for everybody

   285

	}

   286

	return (rts & ~avail_roadtypes) == 0;

   287

}

   288

   289

static inline bool IsHumanPlayer(PlayerID pi)

   290

{

   291

	return !GetPlayer(pi)->is_ai;

   292

}

   293

   294

static inline bool IsInteractivePlayer(PlayerID pi)

   295

{

   296

	return pi == _local_player;

   297

}

   298

   299

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

   300

   301

/* Validate functions for rail building */

   302

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

   303

   304

/* Validate functions for road building */

   305

static inline bool ValParamRoadType(const RoadType rt) { return HasRoadTypesAvail(_current_player, RoadTypeToRoadTypes(rt));}

   306

   307

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

   308

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

   309

 * here. When adding new railtypes, modify this function

   310

 * @param p the player "in action"

   311

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

   312

 */

   313

static inline RailType GetBestRailtype(const Player *p)

   314

{

   315

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

   316

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

   317

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

   318

	return RAILTYPE_RAIL;

   319

}

   320

   321

struct HighScore {

   322

	char company[100];

   323

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

   324

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

   325

};

   326

   327

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

   328

void SaveToHighScore();

   329

void LoadFromHighScore();

   330

int8 SaveHighScoreValue(const Player *p);

   331

int8 SaveHighScoreValueNetwork();

   332

   333

/* Engine Replacement Functions */

   334

   335

/**

   336

 * Remove all engine replacement settings for the given player.

   337

 * @param p Player.

   338

 */

   339

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

   340

   341

/**

   342

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

   343

 * @param p Player.

   344

 * @param engine Engine type.

   345

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

   346

 * replacement is in the list.

   347

 */

   348

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

   349

   350

/**

   351

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

   352

 * @param p Player.

   353

 * @param  engine Engine type to be replaced.

   354

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

   355

 */

   356

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

   357

   358

/**

   359

 * Add an engine replacement for the player.

   360

 * @param p Player.

   361

 * @param old_engine The original engine type.

   362

 * @param new_engine The replacement engine type.

   363

 * @param flags The calling command flags.

   364

 * @return 0 on success, CMD_ERROR on failure.

   365

 */

   366

static inline CommandCost AddEngineReplacementForPlayer(Player *p, EngineID old_engine, EngineID new_engine, GroupID group, uint32 flags) { return AddEngineReplacement(&p->engine_renew_list, old_engine, new_engine, group, flags); }

   367

   368

/**

   369

 * Remove an engine replacement for the player.

   370

 * @param p Player.

   371

 * @param engine The original engine type.

   372

 * @param flags The calling command flags.

   373

 * @return 0 on success, CMD_ERROR on failure.

   374

 */

   375

static inline CommandCost RemoveEngineReplacementForPlayer(Player *p, EngineID engine, GroupID group, uint32 flags) {return RemoveEngineReplacement(&p->engine_renew_list, engine, group, flags); }

   376

   377

/**

   378

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

   379

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

   380

 * @param p Player to reset.

   381

 */

   382

void ResetPlayerLivery(Player *p);

   383

   384

#endif /* PLAYER_H */