1

/* $Id$ */

     2

     3

/** @file players.cpp

     4

 */

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "engine_func.h"

     8

#include "player_func.h"

     9

#include "player_gui.h"

    10

#include "town.h"

    11

#include "news_func.h"

    12

#include "saveload.h"

    13

#include "command_func.h"

    14

#include "network/network.h"

    15

#include "network/network_internal.h"

    16

#include "variables.h"

    17

#include "cheat_func.h"

    18

#include "ai/ai.h"

    19

#include "player_face.h"

    20

#include "group.h"

    21

#include "window_func.h"

    22

#include "tile_map.h"

    23

#include "strings_func.h"

    24

#include "gfx_func.h"

    25

#include "functions.h"

    26

#include "date_func.h"

    27

#include "vehicle_func.h"

    28

#include "sound_func.h"

    29

#include "autoreplace_func.h"

    30

#include "autoreplace_gui.h"

    31

#include "string_func.h"

    32

#include "road_func.h"

    33

#include "rail.h"

    34

#include "settings_type.h"

    35

#include "sprite.h"

    36

    37

#include "table/strings.h"

    38

#include "table/sprites.h"

    39

    40

Player _players[MAX_PLAYERS];

    41

PlayerByte _local_player;

    42

PlayerByte _current_player;

    43

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

    44

byte _player_colors[MAX_PLAYERS];

    45

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

    46

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

    47

    48

/**

    49

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

    50

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

    51

 * @param new_player the new player

    52

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

    53

 */

    54

void SetLocalPlayer(PlayerID new_player)

    55

{

    56

	/* Player could also be PLAYER_SPECTATOR or OWNER_NONE */

    57

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

    58

    59

	_local_player = new_player;

    60

    61

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

    62

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

    63

		const Player *p = GetPlayer(new_player);

    64

		_patches.autorenew        = p->engine_renew;

    65

		_patches.autorenew_months = p->engine_renew_months;

    66

		_patches.autorenew_money  = p->engine_renew_money;

    67

		InvalidateWindow(WC_GAME_OPTIONS, 0);

    68

	}

    69

}

    70

    71

bool IsHumanPlayer(PlayerID pi)

    72

{

    73

	return !GetPlayer(pi)->is_ai;

    74

}

    75

    76

    77

uint16 GetDrawStringPlayerColor(PlayerID player)

    78

{

    79

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

    80

	 * of the player */

    81

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

    82

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

    83

}

    84

    85

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

    86

{

    87

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

    88

}

    89

    90

/**

    91

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

    92

 *

    93

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

    94

 * - 4 and 5: chin

    95

 * - 6 to 9: eyebrows

    96

 * - 10 to 13: nose

    97

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

    98

 * - 16 to 19: hair

    99

 * - 20 to 22: eye color

   100

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

   101

 * - 28 to 30: glasses

   102

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

   103

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

   104

 *

   105

 * @param face the face in the old format

   106

 * @return the face in the new format

   107

 */

   108

PlayerFace ConvertFromOldPlayerFace(uint32 face)

   109

{

   110

	PlayerFace pf = 0;

   111

	GenderEthnicity ge = GE_WM;

   112

   113

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

   114

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

   115

   116

	SetPlayerFaceBits(pf, PFV_GEN_ETHN,    ge, ge);

   117

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

   118

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

   119

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

   120

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

   121

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

   122

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

   123

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

   124

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

   125

   126

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

   127

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

   128

		SetPlayerFaceBits(pf, PFV_HAS_MOUSTACHE, ge, true);

   129

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

   130

	} else {

   131

		if (!HasBit(ge, GENDER_FEMALE)) {

   132

			lips = lips * 15 / 16;

   133

			lips -= 3;

   134

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

   135

		} else {

   136

			lips = ScalePlayerFaceValue(PFV_LIPS, ge, lips);

   137

		}

   138

		SetPlayerFaceBits(pf, PFV_LIPS, ge, lips);

   139

   140

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

   141

		if (ge == GE_WF) {

   142

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

   143

		} else {

   144

			nose = ScalePlayerFaceValue(PFV_NOSE, ge, nose);

   145

		}

   146

		SetPlayerFaceBits(pf, PFV_NOSE, ge, nose);

   147

	}

   148

   149

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

   150

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

   151

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

   152

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

   153

	}

   154

   155

	return pf;

   156

}

   157

   158

/**

   159

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

   160

 * Unused bits are not enforced to be 0.

   161

 * @param pf the fact to check

   162

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

   163

 */

   164

bool IsValidPlayerFace(PlayerFace pf)

   165

{

   166

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

   167

   168

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

   169

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

   170

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

   171

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

   172

   173

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

   174

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

   175

		switch (pfv) {

   176

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

   177

			case PFV_LIPS:        /* FALL THROUGH */

   178

			case PFV_NOSE:        if (has_moustache)    continue; break;

   179

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

   180

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

   181

			default: break;

   182

		}

   183

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

   184

	}

   185

   186

	return true;

   187

}

   188

   189

void InvalidatePlayerWindows(const Player *p)

   190

{

   191

	PlayerID pid = p->index;

   192

   193

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

   194

	InvalidateWindow(WC_FINANCES, pid);

   195

}

   196

   197

bool CheckPlayerHasMoney(CommandCost cost)

   198

{

   199

	if (cost.GetCost() > 0) {

   200

		PlayerID pid = _current_player;

   201

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

   202

			SetDParam(0, cost.GetCost());

   203

			_error_message = STR_0003_NOT_ENOUGH_CASH_REQUIRES;

   204

			return false;

   205

		}

   206

	}

   207

	return true;

   208

}

   209

   210

static void SubtractMoneyFromAnyPlayer(Player *p, CommandCost cost)

   211

{

   212

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

   213

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

   214

   215

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

   216

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

   217

   218

	if (HasBit(1 << EXPENSES_TRAIN_INC    |

   219

	           1 << EXPENSES_ROADVEH_INC  |

   220

	           1 << EXPENSES_AIRCRAFT_INC |

   221

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

   222

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

   223

	} else if (HasBit(1 << EXPENSES_TRAIN_RUN    |

   224

	                  1 << EXPENSES_ROADVEH_RUN  |

   225

	                  1 << EXPENSES_AIRCRAFT_RUN |

   226

	                  1 << EXPENSES_SHIP_RUN     |

   227

	                  1 << EXPENSES_PROPERTY     |

   228

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

   229

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

   230

	}

   231

   232

	InvalidatePlayerWindows(p);

   233

}

   234

   235

void SubtractMoneyFromPlayer(CommandCost cost)

   236

{

   237

	PlayerID pid = _current_player;

   238

   239

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

   240

}

   241

   242

void SubtractMoneyFromPlayerFract(PlayerID player, CommandCost cst)

   243

{

   244

	Player *p = GetPlayer(player);

   245

	byte m = p->player_money_fraction;

   246

	Money cost = cst.GetCost();

   247

   248

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

   249

	cost >>= 8;

   250

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

   251

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

   252

}

   253

   254

void GetNameOfOwner(Owner owner, TileIndex tile)

   255

{

   256

	SetDParam(2, owner);

   257

   258

	if (owner != OWNER_TOWN) {

   259

		if (!IsValidPlayer(owner)) {

   260

			SetDParam(0, STR_0150_SOMEONE);

   261

		} else {

   262

			const Player* p = GetPlayer(owner);

   263

   264

			SetDParam(0, STR_COMPANY_NAME);

   265

			SetDParam(1, p->index);

   266

		}

   267

	} else {

   268

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

   269

   270

		SetDParam(0, STR_TOWN);

   271

		SetDParam(1, t->index);

   272

	}

   273

}

   274

   275

   276

bool CheckOwnership(PlayerID owner)

   277

{

   278

	assert(owner < OWNER_END);

   279

   280

	if (owner == _current_player) return true;

   281

	_error_message = STR_013B_OWNED_BY;

   282

	GetNameOfOwner(owner, 0);

   283

	return false;

   284

}

   285

   286

bool CheckTileOwnership(TileIndex tile)

   287

{

   288

	Owner owner = GetTileOwner(tile);

   289

   290

	assert(owner < OWNER_END);

   291

   292

	if (owner == _current_player) return true;

   293

	_error_message = STR_013B_OWNED_BY;

   294

   295

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

   296

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

   297

	return false;

   298

}

   299

   300

static void GenerateCompanyName(Player *p)

   301

{

   302

	TileIndex tile;

   303

	Town *t;

   304

	StringID str;

   305

	Player *pp;

   306

	uint32 strp;

   307

	char buffer[100];

   308

   309

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

   310

   311

	tile = p->last_build_coordinate;

   312

	if (tile == 0) return;

   313

   314

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

   315

   316

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

   317

		str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_PLAYERNAME_START;

   318

		strp = t->townnameparts;

   319

   320

verify_name:;

   321

		/* No player must have this name already */

   322

		FOR_ALL_PLAYERS(pp) {

   323

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

   324

		}

   325

   326

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

   327

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

   328

			goto bad_town_name;

   329

   330

set_name:;

   331

		p->name_1 = str;

   332

		p->name_2 = strp;

   333

   334

		MarkWholeScreenDirty();

   335

   336

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

   337

			SetDParam(0, t->index);

   338

			AddNewsItem((StringID)(p->index | NB_BNEWCOMPANY), NM_CALLBACK, NF_TILE, NT_COMPANY_INFO, DNC_BANKRUPCY, p->last_build_coordinate, 0);

   339

		}

   343

		return;

   344

	}

   345

bad_town_name:;

   346

   347

	if (p->president_name_1 == SPECSTR_PRESIDENT_NAME) {

   348

		str = SPECSTR_ANDCO_NAME;

   349

		strp = p->president_name_2;

   350

		goto set_name;

   351

	} else {

   352

		str = SPECSTR_ANDCO_NAME;

   353

		strp = Random();

   354

		goto verify_name;

   355

	}

   356

}

   357

   358

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

   359

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

   360

	{ COLOUR_BLUE,       COLOUR_LIGHT_BLUE }, // COLOUR_DARK_BLUE

   361

	{ COLOUR_GREEN,      COLOUR_DARK_GREEN }, // COLOUR_PALE_GREEN

   362

	{ INVALID_COLOUR,    INVALID_COLOUR    }, // COLOUR_PINK

   363

	{ COLOUR_ORANGE,     INVALID_COLOUR    }, // COLOUR_YELLOW

   364

	{ INVALID_COLOUR,    INVALID_COLOUR    }, // COLOUR_RED

   365

	{ COLOUR_DARK_BLUE,  COLOUR_BLUE       }, // COLOUR_LIGHT_BLUE

   366

	{ COLOUR_PALE_GREEN, COLOUR_DARK_GREEN }, // COLOUR_GREEN

   367

	{ COLOUR_PALE_GREEN, COLOUR_GREEN      }, // COLOUR_DARK_GREEN

   368

	{ COLOUR_BLUE,       COLOUR_LIGHT_BLUE }, // COLOUR_BLUE

   369

	{ COLOUR_BROWN,      COLOUR_ORANGE     }, // COLOUR_CREAM

   370

	{ COLOUR_PURPLE,     INVALID_COLOUR    }, // COLOUR_MAUVE

   371

	{ COLOUR_MAUVE,      INVALID_COLOUR    }, // COLOUR_PURPLE

   372

	{ COLOUR_YELLOW,     COLOUR_CREAM      }, // COLOUR_ORANGE

   373

	{ COLOUR_CREAM,      INVALID_COLOUR    }, // COLOUR_BROWN

   374

	{ COLOUR_WHITE,      INVALID_COLOUR    }, // COLOUR_GREY

   375

	{ COLOUR_GREY,       INVALID_COLOUR    }, // COLOUR_WHITE

   376

};

   377

   378

static byte GeneratePlayerColour()

   379

{

   380

	Colours colours[COLOUR_END];

   381

   382

	/* Initialize array */

   383

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

   384

   385

	/* And randomize it */

   386

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

   387

		uint r = Random();

   388

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

   389

	}

   390

   391

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

   392

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

   393

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

   394

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

   395

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

   396

			}

   397

		}

   398

	};

   399

   400

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

   401

	Player *p;

   402

	FOR_ALL_PLAYERS(p) {

   403

		if (!p->is_active) continue;

   404

   405

		Colours pcolour = (Colours)p->player_color;

   406

   407

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

   408

			if (colours[i] == pcolour) {

   409

				colours[i] = INVALID_COLOUR;

   410

				break;

   411

			}

   412

		}

   413

   414

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

   415

			Colours similar = _similar_colour[pcolour][j];

   416

			if (similar == INVALID_COLOUR) break;

   417

   418

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

   419

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

   420

			}

   421

		}

   422

	}

   423

   424

	/* Return the first available color */

   425

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

   426

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

   427

	}

   428

   429

	NOT_REACHED();

   430

}

   431

   432

static void GeneratePresidentName(Player *p)

   433

{

   434

	Player *pp;

   435

	char buffer[100], buffer2[40];

   436

   437

	for (;;) {

   438

restart:;

   439

   440

		p->president_name_2 = Random();

   441

		p->president_name_1 = SPECSTR_PRESIDENT_NAME;

   442

   443

		SetDParam(0, p->index);

   444

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

   445

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

   446

			continue;

   447

   448

		FOR_ALL_PLAYERS(pp) {

   449

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

   450

				SetDParam(0, pp->index);

   451

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

   452

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

   453

					goto restart;

   454

			}

   455

		}

   456

		return;

   457

	}

   458

}

   459

   460

static Player *AllocatePlayer()

   461

{

   462

	Player *p;

   463

	/* Find a free slot */

   464

	FOR_ALL_PLAYERS(p) {

   465

		if (!p->is_active) {

   466

			PlayerID i = p->index;

   467

			memset(p, 0, sizeof(Player));

   468

			p->index = i;

   469

			p->is_noai = true;

   470

			return p;

   471

		}

   472

	}

   473

	return NULL;

   474

}

   475

   476

void ResetPlayerLivery(Player *p)

   477

{

   478

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

   479

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

   480

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

   481

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

   482

	}

   483

}

   484

   485

/**

   486

 * Create a new player and sets all player variables default values

   487

 *

   488

 * @param is_ai is a ai player?

   489

 * @return the player struct

   490

 */

   491

Player *DoStartupNewPlayer(bool is_ai)

   492