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

    32

#include "autoreplace_gui.h"

    33

#include "string_func.h"

    34

#include "road_func.h"

    35

#include "rail.h"

    36

#include "settings_type.h"

    37

#include "sprite.h"

    38

#include "debug.h"

    39

    40

#include "table/strings.h"

    41

#include "table/sprites.h"

    42

    43

Player _players[MAX_PLAYERS];

    44

PlayerByte _local_player;

    45

PlayerByte _current_player;

    46

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

    47

byte _player_colors[MAX_PLAYERS];

    48

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

    49

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

    50

    51

/**

    52

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

    53

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

    54

 * @param new_player the new player

    55

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

    56

 */

    57

void SetLocalPlayer(PlayerID new_player)

    58

{

    59

	/* Player could also be PLAYER_SPECTATOR or OWNER_NONE */

    60

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

    61

    62

	_local_player = new_player;

    63

    64

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

    65

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

    66

		const Player *p = GetPlayer(new_player);

    67

		_settings_client.gui.autorenew        = p->engine_renew;

    68

		_settings_client.gui.autorenew_months = p->engine_renew_months;

    69

		_settings_client.gui.autorenew_money  = p->engine_renew_money;

    70

		InvalidateWindow(WC_GAME_OPTIONS, 0);

    71

	}

    72

}

    73

    74

bool IsHumanPlayer(PlayerID pi)

    75

{

    76

	return !GetPlayer(pi)->is_ai;

    77

}

    78

    79

    80

uint16 GetDrawStringPlayerColor(PlayerID player)

    81

{

    82

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

    83

	 * of the player */

    84

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

    85

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

    86

}

    87

    88

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

    89

{

    90

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

    91

}

    92

    93

/**

    94

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

    95

 *

    96

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

    97

 * - 4 and 5: chin

    98

 * - 6 to 9: eyebrows

    99

 * - 10 to 13: nose

   100

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

   101

 * - 16 to 19: hair

   102

 * - 20 to 22: eye color

   103

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

   104

 * - 28 to 30: glasses

   105

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

   106

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

   107

 *

   108

 * @param face the face in the old format

   109

 * @return the face in the new format

   110

 */

   111

PlayerFace ConvertFromOldPlayerFace(uint32 face)

   112

{

   113

	PlayerFace pf = 0;

   114

	GenderEthnicity ge = GE_WM;

   115

   116

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

   117

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

   118

   119

	SetPlayerFaceBits(pf, PFV_GEN_ETHN,    ge, ge);

   120

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

   121

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

   122

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

   123

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

   124

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

   125

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

   126

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

   127

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

   128

   129

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

   130

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

   131

		SetPlayerFaceBits(pf, PFV_HAS_MOUSTACHE, ge, true);

   132

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

   133

	} else {

   134

		if (!HasBit(ge, GENDER_FEMALE)) {

   135

			lips = lips * 15 / 16;

   136

			lips -= 3;

   137

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

   138

		} else {

   139

			lips = ScalePlayerFaceValue(PFV_LIPS, ge, lips);

   140

		}

   141

		SetPlayerFaceBits(pf, PFV_LIPS, ge, lips);

   142

   143

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

   144

		if (ge == GE_WF) {

   145

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

   146

		} else {

   147

			nose = ScalePlayerFaceValue(PFV_NOSE, ge, nose);

   148

		}

   149

		SetPlayerFaceBits(pf, PFV_NOSE, ge, nose);

   150

	}

   151

   152

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

   153

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

   154

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

   155

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

   156

	}

   157

   158

	return pf;

   159

}

   160

   161

/**

   162

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

   163

 * Unused bits are not enforced to be 0.

   164

 * @param pf the fact to check

   165

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

   166

 */

   167

bool IsValidPlayerFace(PlayerFace pf)

   168

{

   169

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

   170

   171

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

   172

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

   173

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

   174

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

   175

   176

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

   177

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

   178

		switch (pfv) {

   179

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

   180

			case PFV_LIPS:        /* FALL THROUGH */

   181

			case PFV_NOSE:        if (has_moustache)    continue; break;

   182

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

   183

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

   184

			default: break;

   185

		}

   186

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

   187

	}

   188

   189

	return true;

   190

}

   191

   192

void InvalidatePlayerWindows(const Player *p)

   193

{

   194

	PlayerID pid = p->index;

   195

   196

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

   197

	InvalidateWindow(WC_FINANCES, pid);

   198

}

   199

   200

bool CheckPlayerHasMoney(CommandCost cost)

   201

{

   202

	if (cost.GetCost() > 0) {

   203

		PlayerID pid = _current_player;

   204

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

   205

			SetDParam(0, cost.GetCost());

   206

			_error_message = STR_0003_NOT_ENOUGH_CASH_REQUIRES;

   207

			return false;

   208

		}

   209

	}

   210

	return true;

   211

}

   212

   213

/** Backs up current economic data for a player

   214

 */

   215

PlayerMoneyBackup::PlayerMoneyBackup(Player *player)

   216

{

   217

	p = player;

   218

	memcpy(backup_yearly_expenses, p->yearly_expenses, EXPENSES_END * sizeof(Money));

   219

	backup_cur_economy = p->cur_economy;

   220

}

   221

   222

/** Restore the economic data from last backup

   223

 * This should only be used right after Player::BackupEconomy()

   224

 */

   225

void PlayerMoneyBackup::Restore()

   226

{

   227

	memcpy(p->yearly_expenses, backup_yearly_expenses, EXPENSES_END * sizeof(Money));

   228

	p->cur_economy = backup_cur_economy;

   229

}

   230

   231

static void SubtractMoneyFromAnyPlayer(Player *p, CommandCost cost)

   232

{

   233

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

   234

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

   235

   236

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

   237

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

   238

   239

	if (HasBit(1 << EXPENSES_TRAIN_INC    |

   240

	           1 << EXPENSES_ROADVEH_INC  |

   241

	           1 << EXPENSES_AIRCRAFT_INC |

   242

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

   243

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

   244

	} else if (HasBit(1 << EXPENSES_TRAIN_RUN    |

   245

	                  1 << EXPENSES_ROADVEH_RUN  |

   246

	                  1 << EXPENSES_AIRCRAFT_RUN |

   247

	                  1 << EXPENSES_SHIP_RUN     |

   248

	                  1 << EXPENSES_PROPERTY     |

   249

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

   250

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

   251

	}

   252

   253

	InvalidatePlayerWindows(p);

   254

}

   255

   256

void SubtractMoneyFromPlayer(CommandCost cost)

   257

{

   258

	PlayerID pid = _current_player;

   259

   260

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

   261

}

   262

   263

void SubtractMoneyFromPlayerFract(PlayerID player, CommandCost cst)

   264

{

   265

	Player *p = GetPlayer(player);

   266

	byte m = p->player_money_fraction;

   267

	Money cost = cst.GetCost();

   268

   269

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

   270

	cost >>= 8;

   271

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

   272

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

   273

}

   274

   275

void GetNameOfOwner(Owner owner, TileIndex tile)

   276

{

   277

	SetDParam(2, owner);

   278

   279

	if (owner != OWNER_TOWN) {

   280

		if (!IsValidPlayer(owner)) {

   281

			SetDParam(0, STR_0150_SOMEONE);

   282

		} else {

   283

			const Player* p = GetPlayer(owner);

   284

   285

			SetDParam(0, STR_COMPANY_NAME);

   286

			SetDParam(1, p->index);

   287

		}

   288

	} else {

   289

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

   290

   291

		SetDParam(0, STR_TOWN);

   292

		SetDParam(1, t->index);

   293

	}

   294

}

   295

   296

   297

bool CheckOwnership(PlayerID owner)

   298

{

   299

	assert(owner < OWNER_END);

   300

   301

	if (owner == _current_player) return true;

   302

	_error_message = STR_013B_OWNED_BY;

   303

	GetNameOfOwner(owner, 0);

   304

	return false;

   305

}

   306

   307

bool CheckTileOwnership(TileIndex tile)

   308

{

   309

	Owner owner = GetTileOwner(tile);

   310

   311

	assert(owner < OWNER_END);

   312

   313

	if (owner == _current_player) return true;

   314

	_error_message = STR_013B_OWNED_BY;

   315

   316

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

   317

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

   318

	return false;

   319

}

   320

   321

static void GenerateCompanyName(Player *p)

   322

{

   323

	TileIndex tile;

   324

	Town *t;

   325

	StringID str;

   326

	Player *pp;

   327

	uint32 strp;

   328

	char buffer[100];

   329

   330

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

   331

   332

	tile = p->last_build_coordinate;

   333

	if (tile == 0) return;

   334

   335

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

   336

   337

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

   338

		str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_PLAYERNAME_START;

   339

		strp = t->townnameparts;

   340

   341

verify_name:;

   342

		/* No player must have this name already */

   343

		FOR_ALL_PLAYERS(pp) {

   344

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

   345

		}

   346

   347

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

   348

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

   349

			goto bad_town_name;

   350

   351

set_name:;

   352

		p->name_1 = str;

   353

		p->name_2 = strp;

   354

   355

		MarkWholeScreenDirty();

   356

   357

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

   358

			SetDParam(0, STR_705E_NEW_TRANSPORT_COMPANY_LAUNCHED);

   359

			SetDParam(1, STR_705F_STARTS_CONSTRUCTION_NEAR);

   360

			SetDParam(2, p->index);

   361

			SetDParam(3, t->index);

   362

			AddNewsItem(STR_02B6, NS_COMPANY_NEW, p->last_build_coordinate, p->index);

   363

		}

   364

		for (PlayerID i = PLAYER_FIRST; i < MAX_PLAYERS; i++) {

   365

			if (i != p->index) AI_Event(i, new AIEventCompanyNew(p->index));

   366

		}

   367

		return;

   368

	}

   369

bad_town_name:;

   370

   371

	if (p->president_name_1 == SPECSTR_PRESIDENT_NAME) {

   372

		str = SPECSTR_ANDCO_NAME;

   373

		strp = p->president_name_2;

   374

		goto set_name;

   375

	} else {

   376

		str = SPECSTR_ANDCO_NAME;

   377

		strp = Random();

   378

		goto verify_name;

   379

	}

   380

}

   381

   382

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

   383

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

   384

	{ COLOUR_BLUE,       COLOUR_LIGHT_BLUE }, // COLOUR_DARK_BLUE

   385

	{ COLOUR_GREEN,      COLOUR_DARK_GREEN }, // COLOUR_PALE_GREEN

   386

	{ INVALID_COLOUR,    INVALID_COLOUR    }, // COLOUR_PINK

   387

	{ COLOUR_ORANGE,     INVALID_COLOUR    }, // COLOUR_YELLOW

   388

	{ INVALID_COLOUR,    INVALID_COLOUR    }, // COLOUR_RED

   389

	{ COLOUR_DARK_BLUE,  COLOUR_BLUE       }, // COLOUR_LIGHT_BLUE

   390

	{ COLOUR_PALE_GREEN, COLOUR_DARK_GREEN }, // COLOUR_GREEN

   391

	{ COLOUR_PALE_GREEN, COLOUR_GREEN      }, // COLOUR_DARK_GREEN

   392

	{ COLOUR_BLUE,       COLOUR_LIGHT_BLUE }, // COLOUR_BLUE

   393

	{ COLOUR_BROWN,      COLOUR_ORANGE     }, // COLOUR_CREAM

   394

	{ COLOUR_PURPLE,     INVALID_COLOUR    }, // COLOUR_MAUVE

   395

	{ COLOUR_MAUVE,      INVALID_COLOUR    }, // COLOUR_PURPLE

   396

	{ COLOUR_YELLOW,     COLOUR_CREAM      }, // COLOUR_ORANGE

   397

	{ COLOUR_CREAM,      INVALID_COLOUR    }, // COLOUR_BROWN

   398

	{ COLOUR_WHITE,      INVALID_COLOUR    }, // COLOUR_GREY

   399

	{ COLOUR_GREY,       INVALID_COLOUR    }, // COLOUR_WHITE

   400

};

   401

   402

static byte GeneratePlayerColour()

   403

{

   404

	Colours colours[COLOUR_END];

   405

   406

	/* Initialize array */

   407

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

   408

   409

	/* And randomize it */

   410

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

   411

		uint r = Random();

   412

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

   413

	}

   414

   415

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

   416

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

   417

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

   418

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

   419

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

   420

			}

   421

		}

   422

	};

   423

   424

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

   425

	Player *p;

   426

	FOR_ALL_PLAYERS(p) {

   427

		if (!p->is_active) continue;

   428

   429

		Colours pcolour = (Colours)p->player_color;

   430

   431

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

   432

			if (colours[i] == pcolour) {

   433

				colours[i] = INVALID_COLOUR;

   434

				break;

   435

			}

   436

		}

   437

   438

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

   439

			Colours similar = _similar_colour[pcolour][j];

   440

			if (similar == INVALID_COLOUR) break;

   441

   442

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

   443

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

   444

			}

   445

		}

   446

	}

   447

   448

	/* Return the first available color */

   449

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

   450

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

   451

	}

   452

   453

	NOT_REACHED();

   454

}

   455

   456

static void GeneratePresidentName(Player *p)

   457

{

   458

	Player *pp;

   459

	char buffer[100], buffer2[40];

   460

   461

	for (;;) {

   462

restart:;

   463

   464

		p->president_name_2 = Random();

   465

		p->president_name_1 = SPECSTR_PRESIDENT_NAME;

   466

   467

		SetDParam(0, p->index);

   468

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

   469

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

   470

			continue;

   471

   472

		FOR_ALL_PLAYERS(pp) {

   473

			if (pp->is_active && p != pp) {

   474

				SetDParam(0, pp->index);

   475

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

   476

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

   477

					goto restart;

   478

			}

   479

		}

   480

		return;

   481

	}

   482

}

   483

   484

static Player *AllocatePlayer()

   485

{

   486

	Player *p;

   487

	/* Find a free slot */

   488

	FOR_ALL_PLAYERS(p) {

   489

		if (!p->is_active) {

   490

			free(p->name);

   491

			free(p->president_name);