1

/* $Id$ */

     2

     3

/** @file players.cpp Handling of players. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "engine_func.h"

     8

#include "engine_base.h"

     9

#include "player_func.h"

    10

#include "player_gui.h"

    11

#include "town.h"

    12

#include "news_func.h"

    13

#include "saveload.h"

    14

#include "command_func.h"

    15

#include "network/network.h"

    16

#include "network/network_func.h"

    17

#include "variables.h"

    18

#include "cheat_func.h"

    19

#include "ai/ai.h"

    20

#include "player_face.h"

    21

#include "group.h"

    22

#include "window_func.h"

    23

#include "tile_map.h"

    24

#include "strings_func.h"

    25

#include "gfx_func.h"

    26

#include "functions.h"

    27

#include "date_func.h"

    28

#include "vehicle_func.h"

    29

#include "sound_func.h"

    30

#include "core/alloc_func.hpp"

    31

#include "core/sort_func.hpp"

    32

#include "autoreplace_func.h"

    33

#include "autoreplace_gui.h"

    34

#include "string_func.h"

    35

#include "ai/default/default.h"

    36

#include "ai/trolly/trolly.h"

    37

#include "road_func.h"

    38

#include "rail.h"

    39

#include "sprite.h"

    40

#include "debug.h"

    41

#include "oldpool_func.h"

    42

    43

#include "table/strings.h"

    44

#include "table/sprites.h"

    45

    46

PlayerByte _local_player;

    47

PlayerByte _current_player;

    48

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

    49

byte _player_colors[MAX_PLAYERS];

    50

PlayerFace _player_face; ///< for player face storage in openttd.cfg

    51

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

    52

    53

DEFINE_OLD_POOL_GENERIC(Player, Player)

    54

    55

Player::Player(uint16 name_1, bool is_ai) : name_1(name_1), is_ai(is_ai)

    56

{

    57

	for (uint j = 0; j < 4; j++) this->share_owners[j] = PLAYER_SPECTATOR;

    58

}

    59

    60

Player::~Player()

    61

{

    62

	free(this->name);

    63

	free(this->president_name);

    64

	free(this->num_engines);

    65

    66

	if (CleaningPool()) return;

    67

    68

	DeletePlayerWindows(this->index);

    69

	this->name_1 = 0;

    70

}

    71

    72

/**

    73

 * Sets the local player and updates the patch settings that are set on a

    74

 * per-company (player) basis to reflect the core's state in the GUI.

    75

 * @param new_player the new player

    76

 * @pre IsValidPlayerID(new_player) || new_player == PLAYER_SPECTATOR || new_player == OWNER_NONE

    77

 */

    78

void SetLocalPlayer(PlayerID new_player)

    79

{

    80

	/* Player could also be PLAYER_SPECTATOR or OWNER_NONE */

    81

	assert(IsValidPlayerID(new_player) || new_player == PLAYER_SPECTATOR || new_player == OWNER_NONE);

    82

    83

	_local_player = new_player;

    84

    85

	/* Do not update the patches if we are in the intro GUI */

    86

	if (IsValidPlayerID(new_player) && _game_mode != GM_MENU) {

    87

		const Player *p = GetPlayer(new_player);

    88

		_settings_client.gui.autorenew        = p->engine_renew;

    89

		_settings_client.gui.autorenew_months = p->engine_renew_months;

    90

		_settings_client.gui.autorenew_money  = p->engine_renew_money;

    91

		InvalidateWindow(WC_GAME_OPTIONS, 0);

    92

	}

    93

}

    94

    95

bool IsHumanPlayer(PlayerID pi)

    96

{

    97

	return !GetPlayer(pi)->is_ai;

    98

}

    99

   100

   101

uint16 GetDrawStringPlayerColor(PlayerID player)

   102

{

   103

	/* Get the color for DrawString-subroutines which matches the color

   104

	 * of the player */

   105

	if (!IsValidPlayerID(player)) return _colour_gradient[COLOUR_WHITE][4] | IS_PALETTE_COLOR;

   106

	return (_colour_gradient[_player_colors[player]][4]) | IS_PALETTE_COLOR;

   107

}

   108

   109

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

   110

{

   111

	DrawSprite(SPR_PLAYER_ICON, PLAYER_SPRITE_COLOR(p), x, y);

   112

}

   113

   114

/**

   115

 * Converts an old player face format to the new player face format

   116

 *

   117

 * Meaning of the bits in the old face (some bits are used in several times):

   118

 * - 4 and 5: chin

   119

 * - 6 to 9: eyebrows

   120

 * - 10 to 13: nose

   121

 * - 13 to 15: lips (also moustache for males)

   122

 * - 16 to 19: hair

   123

 * - 20 to 22: eye color

   124

 * - 20 to 27: tie, ear rings etc.

   125

 * - 28 to 30: glasses

   126

 * - 19, 26 and 27: race (bit 27 set and bit 19 equal to bit 26 = black, otherwise white)

   127

 * - 31: gender (0 = male, 1 = female)

   128

 *

   129

 * @param face the face in the old format

   130

 * @return the face in the new format

   131

 */

   132

PlayerFace ConvertFromOldPlayerFace(uint32 face)

   133

{

   134

	PlayerFace pf = 0;

   135

	GenderEthnicity ge = GE_WM;

   136

   137

	if (HasBit(face, 31)) SetBit(ge, GENDER_FEMALE);

   138

	if (HasBit(face, 27) && (HasBit(face, 26) == HasBit(face, 19))) SetBit(ge, ETHNICITY_BLACK);

   139

   140

	SetPlayerFaceBits(pf, PFV_GEN_ETHN,    ge, ge);

   141

	SetPlayerFaceBits(pf, PFV_HAS_GLASSES, ge, GB(face, 28, 3) <= 1);

   142

	SetPlayerFaceBits(pf, PFV_EYE_COLOUR,  ge, HasBit(ge, ETHNICITY_BLACK) ? 0 : ClampU(GB(face, 20, 3), 5, 7) - 5);

   143

	SetPlayerFaceBits(pf, PFV_CHIN,        ge, ScalePlayerFaceValue(PFV_CHIN,     ge, GB(face,  4, 2)));

   144

	SetPlayerFaceBits(pf, PFV_EYEBROWS,    ge, ScalePlayerFaceValue(PFV_EYEBROWS, ge, GB(face,  6, 4)));

   145

	SetPlayerFaceBits(pf, PFV_HAIR,        ge, ScalePlayerFaceValue(PFV_HAIR,     ge, GB(face, 16, 4)));

   146

	SetPlayerFaceBits(pf, PFV_JACKET,      ge, ScalePlayerFaceValue(PFV_JACKET,   ge, GB(face, 20, 2)));

   147

	SetPlayerFaceBits(pf, PFV_COLLAR,      ge, ScalePlayerFaceValue(PFV_COLLAR,   ge, GB(face, 22, 2)));

   148

	SetPlayerFaceBits(pf, PFV_GLASSES,     ge, GB(face, 28, 1));

   149

   150

	uint lips = GB(face, 10, 4);

   151

	if (!HasBit(ge, GENDER_FEMALE) && lips < 4) {

   152

		SetPlayerFaceBits(pf, PFV_HAS_MOUSTACHE, ge, true);

   153

		SetPlayerFaceBits(pf, PFV_MOUSTACHE,     ge, max(lips, 1U) - 1);

   154

	} else {

   155

		if (!HasBit(ge, GENDER_FEMALE)) {

   156

			lips = lips * 15 / 16;

   157

			lips -= 3;

   158

			if (HasBit(ge, ETHNICITY_BLACK) && lips > 8) lips = 0;

   159

		} else {

   160

			lips = ScalePlayerFaceValue(PFV_LIPS, ge, lips);

   161

		}

   162

		SetPlayerFaceBits(pf, PFV_LIPS, ge, lips);

   163

   164

		uint nose = GB(face, 13, 3);

   165

		if (ge == GE_WF) {

   166

			nose = (nose * 3 >> 3) * 3 >> 2; // There is 'hole' in the nose sprites for females

   167

		} else {

   168

			nose = ScalePlayerFaceValue(PFV_NOSE, ge, nose);

   169

		}

   170

		SetPlayerFaceBits(pf, PFV_NOSE, ge, nose);

   171

	}

   172

   173

	uint tie_earring = GB(face, 24, 4);

   174

	if (!HasBit(ge, GENDER_FEMALE) || tie_earring < 3) { // Not all females have an earring

   175

		if (HasBit(ge, GENDER_FEMALE)) SetPlayerFaceBits(pf, PFV_HAS_TIE_EARRING, ge, true);

   176

		SetPlayerFaceBits(pf, PFV_TIE_EARRING, ge, HasBit(ge, GENDER_FEMALE) ? tie_earring : ScalePlayerFaceValue(PFV_TIE_EARRING, ge, tie_earring / 2));

   177

	}

   178

   179

	return pf;

   180

}

   181

   182

/**

   183

 * Checks whether a player's face is a valid encoding.

   184

 * Unused bits are not enforced to be 0.

   185

 * @param pf the fact to check

   186

 * @return true if and only if the face is valid

   187

 */

   188

bool IsValidPlayerIDFace(PlayerFace pf)

   189

{

   190

	if (!ArePlayerFaceBitsValid(pf, PFV_GEN_ETHN, GE_WM)) return false;

   191

   192

	GenderEthnicity ge   = (GenderEthnicity)GetPlayerFaceBits(pf, PFV_GEN_ETHN, GE_WM);

   193

	bool has_moustache   = !HasBit(ge, GENDER_FEMALE) && GetPlayerFaceBits(pf, PFV_HAS_MOUSTACHE,   ge) != 0;

   194

	bool has_tie_earring = !HasBit(ge, GENDER_FEMALE) || GetPlayerFaceBits(pf, PFV_HAS_TIE_EARRING, ge) != 0;

   195

	bool has_glasses     = GetPlayerFaceBits(pf, PFV_HAS_GLASSES, ge) != 0;

   196

   197

	if (!ArePlayerFaceBitsValid(pf, PFV_EYE_COLOUR, ge)) return false;

   198

	for (PlayerFaceVariable pfv = PFV_CHEEKS; pfv < PFV_END; pfv++) {

   199

		switch (pfv) {

   200

			case PFV_MOUSTACHE:   if (!has_moustache)   continue; break;

   201

			case PFV_LIPS:        /* FALL THROUGH */

   202

			case PFV_NOSE:        if (has_moustache)    continue; break;

   203

			case PFV_TIE_EARRING: if (!has_tie_earring) continue; break;

   204

			case PFV_GLASSES:     if (!has_glasses)     continue; break;

   205

			default: break;

   206

		}

   207

		if (!ArePlayerFaceBitsValid(pf, pfv, ge)) return false;

   208

	}

   209

   210

	return true;

   211

}

   212

   213

void InvalidatePlayerWindows(const Player *p)

   214

{

   215

	PlayerID pid = p->index;

   216

   217

	if (pid == _local_player) InvalidateWindow(WC_STATUS_BAR, 0);

   218

	InvalidateWindow(WC_FINANCES, pid);

   219

}

   220

   221

bool CheckPlayerHasMoney(CommandCost cost)

   222

{

   223

	if (cost.GetCost() > 0) {

   224

		PlayerID pid = _current_player;

   225

		if (IsValidPlayerID(pid) && cost.GetCost() > GetPlayer(pid)->player_money) {

   226

			SetDParam(0, cost.GetCost());

   227

			_error_message = STR_0003_NOT_ENOUGH_CASH_REQUIRES;

   228

			return false;

   229

		}

   230

	}

   231

	return true;

   232

}

   233

   234

static void SubtractMoneyFromAnyPlayer(Player *p, CommandCost cost)

   235

{

   236

	if (cost.GetCost() == 0) return;

   237

	assert(cost.GetExpensesType() != INVALID_EXPENSES);

   238

   239

	p->player_money -= cost.GetCost();

   240

	p->yearly_expenses[0][cost.GetExpensesType()] += cost.GetCost();

   241

   242

	if (HasBit(1 << EXPENSES_TRAIN_INC    |

   243

	           1 << EXPENSES_ROADVEH_INC  |

   244

	           1 << EXPENSES_AIRCRAFT_INC |

   245

	           1 << EXPENSES_SHIP_INC, cost.GetExpensesType())) {

   246

		p->cur_economy.income -= cost.GetCost();

   247

	} else if (HasBit(1 << EXPENSES_TRAIN_RUN    |

   248

	                  1 << EXPENSES_ROADVEH_RUN  |

   249

	                  1 << EXPENSES_AIRCRAFT_RUN |

   250

	                  1 << EXPENSES_SHIP_RUN     |

   251

	                  1 << EXPENSES_PROPERTY     |

   252

	                  1 << EXPENSES_LOAN_INT, cost.GetExpensesType())) {

   253

		p->cur_economy.expenses -= cost.GetCost();

   254

	}

   255

   256

	InvalidatePlayerWindows(p);

   257

}

   258

   259

void SubtractMoneyFromPlayer(CommandCost cost)

   260

{

   261

	PlayerID pid = _current_player;

   262

   263

	if (IsValidPlayerID(pid)) SubtractMoneyFromAnyPlayer(GetPlayer(pid), cost);

   264

}

   265

   266

void SubtractMoneyFromPlayerFract(PlayerID player, CommandCost cst)

   267

{

   268

	Player *p = GetPlayer(player);

   269

	byte m = p->player_money_fraction;

   270

	Money cost = cst.GetCost();

   271

   272

	p->player_money_fraction = m - (byte)cost;

   273

	cost >>= 8;

   274

	if (p->player_money_fraction > m) cost++;

   275

	if (cost != 0) SubtractMoneyFromAnyPlayer(p, CommandCost(cst.GetExpensesType(), cost));

   276

}

   277

   278

void GetNameOfOwner(Owner owner, TileIndex tile)

   279

{

   280

	SetDParam(2, owner);

   281

   282

	if (owner != OWNER_TOWN) {

   283

		if (!IsValidPlayerID(owner)) {

   284

			SetDParam(0, STR_0150_SOMEONE);

   285

		} else {

   286

			const Player* p = GetPlayer(owner);

   287

   288

			SetDParam(0, STR_COMPANY_NAME);

   289

			SetDParam(1, p->index);

   290

		}

   291

	} else {

   292

		const Town* t = ClosestTownFromTile(tile, (uint)-1);

   293

   294

		SetDParam(0, STR_TOWN);

   295

		SetDParam(1, t->index);

   296

	}

   297

}

   298

   299

   300

bool CheckOwnership(PlayerID owner)

   301

{

   302

	assert(owner < OWNER_END);

   303

   304

	if (owner == _current_player) return true;

   305

	_error_message = STR_013B_OWNED_BY;

   306

	GetNameOfOwner(owner, 0);

   307

	return false;

   308

}

   309

   310

bool CheckTileOwnership(TileIndex tile)

   311

{

   312

	Owner owner = GetTileOwner(tile);

   313

   314

	assert(owner < OWNER_END);

   315

   316

	if (owner == _current_player) return true;

   317

	_error_message = STR_013B_OWNED_BY;

   318

   319

	/* no need to get the name of the owner unless we're the local player (saves some time) */

   320

	if (IsLocalPlayer()) GetNameOfOwner(owner, tile);

   321

	return false;

   322

}

   323

   324

static void GenerateCompanyName(Player *p)

   325

{

   326

	TileIndex tile;

   327

	Town *t;

   328

	StringID str;

   329

	Player *pp;

   330

	uint32 strp;

   331

	char buffer[100];

   332

   333

	if (p->name_1 != STR_SV_UNNAMED) return;

   334

   335

	tile = p->last_build_coordinate;

   336

	if (tile == 0) return;

   337

   338

	t = ClosestTownFromTile(tile, (uint)-1);

   339

   340

	if (IsInsideMM(t->townnametype, SPECSTR_TOWNNAME_START, SPECSTR_TOWNNAME_LAST + 1)) {

   341

		str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_PLAYERNAME_START;

   342

		strp = t->townnameparts;

   343

   344

verify_name:;

   345

		/* No player must have this name already */

   346

		FOR_ALL_PLAYERS(pp) {

   347

			if (pp->name_1 == str && pp->name_2 == strp) goto bad_town_name;

   348

		}

   349

   350

		GetString(buffer, str, lastof(buffer));

   351

		if (strlen(buffer) >= MAX_LENGTH_COMPANY_NAME_BYTES) goto bad_town_name;

   352

   353

set_name:;

   354

		p->name_1 = str;

   355

		p->name_2 = strp;

   356

   357

		MarkWholeScreenDirty();

   358

   359

		if (!IsHumanPlayer(p->index)) {

   360

			CompanyNewsInformation *cni = MallocT<CompanyNewsInformation>(1);

   361

			cni->FillData(p);

   362

			SetDParam(0, STR_705E_NEW_TRANSPORT_COMPANY_LAUNCHED);

   363

			SetDParam(1, STR_705F_STARTS_CONSTRUCTION_NEAR);

   364

			SetDParamStr(2, cni->company_name);

   365

			SetDParam(3, t->index);

   366

			AddNewsItem(STR_02B6, NS_COMPANY_NEW, p->last_build_coordinate, 0, cni);

   367

		}

   368

		return;

   369

	}

   370

bad_town_name:;

   371

   372

	if (p->president_name_1 == SPECSTR_PRESIDENT_NAME) {

   373

		str = SPECSTR_ANDCO_NAME;

   374

		strp = p->president_name_2;

   375

		goto set_name;

   376

	} else {

   377

		str = SPECSTR_ANDCO_NAME;

   378

		strp = Random();

   379

		goto verify_name;

   380

	}

   381

}

   382

   383

static const byte _colour_sort[COLOUR_END] = {2, 2, 3, 2, 3, 2, 3, 2, 3, 2, 2, 2, 3, 1, 1, 1};

   384

static const Colours _similar_colour[COLOUR_END][2] = {

   385

	{ COLOUR_BLUE,       COLOUR_LIGHT_BLUE }, // COLOUR_DARK_BLUE

   386

	{ COLOUR_GREEN,      COLOUR_DARK_GREEN }, // COLOUR_PALE_GREEN

   387

	{ INVALID_COLOUR,    INVALID_COLOUR    }, // COLOUR_PINK

   388

	{ COLOUR_ORANGE,     INVALID_COLOUR    }, // COLOUR_YELLOW

   389

	{ INVALID_COLOUR,    INVALID_COLOUR    }, // COLOUR_RED

   390

	{ COLOUR_DARK_BLUE,  COLOUR_BLUE       }, // COLOUR_LIGHT_BLUE

   391

	{ COLOUR_PALE_GREEN, COLOUR_DARK_GREEN }, // COLOUR_GREEN

   392

	{ COLOUR_PALE_GREEN, COLOUR_GREEN      }, // COLOUR_DARK_GREEN

   393

	{ COLOUR_BLUE,       COLOUR_LIGHT_BLUE }, // COLOUR_BLUE

   394

	{ COLOUR_BROWN,      COLOUR_ORANGE     }, // COLOUR_CREAM

   395

	{ COLOUR_PURPLE,     INVALID_COLOUR    }, // COLOUR_MAUVE

   396

	{ COLOUR_MAUVE,      INVALID_COLOUR    }, // COLOUR_PURPLE

   397

	{ COLOUR_YELLOW,     COLOUR_CREAM      }, // COLOUR_ORANGE

   398

	{ COLOUR_CREAM,      INVALID_COLOUR    }, // COLOUR_BROWN

   399

	{ COLOUR_WHITE,      INVALID_COLOUR    }, // COLOUR_GREY

   400

	{ COLOUR_GREY,       INVALID_COLOUR    }, // COLOUR_WHITE

   401

};

   402

   403

static byte GeneratePlayerColour()

   404

{

   405

	Colours colours[COLOUR_END];

   406

   407

	/* Initialize array */

   408

	for (uint i = 0; i < COLOUR_END; i++) colours[i] = (Colours)i;

   409

   410

	/* And randomize it */

   411

	for (uint i = 0; i < 100; i++) {

   412

		uint r = Random();

   413

		Swap(colours[GB(r, 0, 4)], colours[GB(r, 4, 4)]);

   414

	}

   415

   416

	/* Bubble sort it according to the values in table 1 */

   417

	for (uint i = 0; i < COLOUR_END; i++) {

   418

		for (uint j = 1; j < COLOUR_END; j++) {

   419

			if (_colour_sort[colours[j - 1]] < _colour_sort[colours[j]]) {

   420

				Swap(colours[j - 1], colours[j]);

   421

			}

   422

		}

   423

	};

   424

   425

	/* Move the colors that look similar to each player's color to the side */

   426

	Player *p;

   427

	FOR_ALL_PLAYERS(p) {

   428

		Colours pcolour = (Colours)p->player_color;

   429

   430

		for (uint i = 0; i < COLOUR_END; i++) {

   431

			if (colours[i] == pcolour) {

   432

				colours[i] = INVALID_COLOUR;

   433

				break;

   434

			}

   435

		}

   436

   437

		for (uint j = 0; j < 2; j++) {

   438

			Colours similar = _similar_colour[pcolour][j];

   439

			if (similar == INVALID_COLOUR) break;

   440

   441

			for (uint i = 1; i < COLOUR_END; i++) {

   442

				if (colours[i - 1] == similar) Swap(colours[i - 1], colours[i]);

   443

			}

   444

		}

   445

	}

   446

   447

	/* Return the first available color */

   448

	for (uint i = 0; i < COLOUR_END; i++) {

   449

		if (colours[i] != INVALID_COLOUR) return colours[i];

   450

	}

   451

   452

	NOT_REACHED();

   453

}

   454

   455

static void GeneratePresidentName(Player *p)

   456

{

   457

	Player *pp;

   458

	char buffer[100], buffer2[40];

   459

   460

	for (;;) {

   461

restart:;

   462

   463

		p->president_name_2 = Random();

   464

		p->president_name_1 = SPECSTR_PRESIDENT_NAME;

   465

   466

		SetDParam(0, p->index);

   467

		GetString(buffer, STR_PLAYER_NAME, lastof(buffer));

   468

		if (strlen(buffer) >= 32 || GetStringBoundingBox(buffer).width >= 94)

   469

			continue;

   470

   471

		FOR_ALL_PLAYERS(pp) {

   472

			if (p != pp) {

   473

				SetDParam(0, pp->index);

   474

				GetString(buffer2, STR_PLAYER_NAME, lastof(buffer2));

   475

				if (strcmp(buffer2, buffer) == 0)

   476

					goto restart;

   477

			}

   478

		}

   479

		return;

   480

	}

   481

}

   482

   483

void ResetPlayerLivery(Player *p)

   484

{

   485

	for (LiveryScheme scheme = LS_BEGIN; scheme < LS_END; scheme++) {

   486

		p->livery[scheme].in_use  = false;

   487

		p->livery[scheme].colour1 = p->player_color;

   488

		p->livery[scheme].colour2 = p->player_color;

   489

	}

   490