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 "ai/default/default.h"

    33

#include "ai/trolly/trolly.h"

    34

#include "road_func.h"

    35

#include "rail.h"

    36

#include "sprite.h"

    37

    38

#include "table/strings.h"

    39

#include "table/sprites.h"

    40

    41

Player _players[MAX_PLAYERS];

    42

PlayerByte _local_player;

    43

PlayerByte _current_player;

    44

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

    45

byte _player_colors[MAX_PLAYERS];

    46

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

    47

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

    48

    49

/**

    50

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

    51

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

    52

 * @param new_player the new player

    53

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

    54

 */

    55

void SetLocalPlayer(PlayerID new_player)

    56

{

    57

	/* Player could also be PLAYER_SPECTATOR or OWNER_NONE */

    58

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

    59

    60

	_local_player = new_player;

    61

    62

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

    63

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

    64

		const Player *p = GetPlayer(new_player);

    65

		_patches.autorenew        = p->engine_renew;

    66

		_patches.autorenew_months = p->engine_renew_months;

    67

		_patches.autorenew_money  = p->engine_renew_money;

    68

		InvalidateWindow(WC_GAME_OPTIONS, 0);

    69

	}

    70

}

    71

    72

bool IsHumanPlayer(PlayerID pi)

    73

{

    74

	return !GetPlayer(pi)->is_ai;

    75

}

    76

    77

    78

uint16 GetDrawStringPlayerColor(PlayerID player)

    79

{

    80

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

    81

	 * of the player */

    82

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

    83

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

    84

}

    85

    86

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

    87

{

    88

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

    89

}

    90

    91

/**

    92

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

    93

 *

    94

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

    95

 * - 4 and 5: chin

    96

 * - 6 to 9: eyebrows

    97

 * - 10 to 13: nose

    98

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

    99

 * - 16 to 19: hair

   100

 * - 20 to 22: eye color

   101

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

   102

 * - 28 to 30: glasses

   103

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

   104

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

   105

 *

   106

 * @param face the face in the old format

   107

 * @return the face in the new format

   108

 */

   109

PlayerFace ConvertFromOldPlayerFace(uint32 face)

   110

{

   111

	PlayerFace pf = 0;

   112

	GenderEthnicity ge = GE_WM;

   113

   114

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

   115

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

   116

   117

	SetPlayerFaceBits(pf, PFV_GEN_ETHN,    ge, ge);

   118

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

   119

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

   120

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

   121

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

   122

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

   123

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

   124

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

   125

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

   126

   127

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

   128

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

   129

		SetPlayerFaceBits(pf, PFV_HAS_MOUSTACHE, ge, true);

   130

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

   131

	} else {

   132

		if (!HasBit(ge, GENDER_FEMALE)) {

   133

			lips = lips * 15 / 16;

   134

			lips -= 3;

   135

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

   136

		} else {

   137

			lips = ScalePlayerFaceValue(PFV_LIPS, ge, lips);

   138

		}

   139

		SetPlayerFaceBits(pf, PFV_LIPS, ge, lips);

   140

   141

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

   142

		if (ge == GE_WF) {

   143

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

   144

		} else {

   145

			nose = ScalePlayerFaceValue(PFV_NOSE, ge, nose);

   146

		}

   147

		SetPlayerFaceBits(pf, PFV_NOSE, ge, nose);

   148

	}

   149

   150

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

   151

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

   152

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

   153

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

   154

	}

   155

   156

	return pf;

   157

}

   158

   159

/**

   160

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

   161

 * Unused bits are not enforced to be 0.

   162

 * @param pf the fact to check

   163

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

   164

 */

   165

bool IsValidPlayerFace(PlayerFace pf)

   166

{

   167

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

   168

   169

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

   170

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

   171

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

   172

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

   173

   174

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

   175

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

   176

		switch (pfv) {

   177

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

   178

			case PFV_LIPS:        /* FALL THROUGH */

   179

			case PFV_NOSE:        if (has_moustache)    continue; break;

   180

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

   181

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

   182

			default: break;

   183

		}

   184

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

   185

	}

   186

   187

	return true;

   188

}

   189

   190

void InvalidatePlayerWindows(const Player *p)

   191

{

   192

	PlayerID pid = p->index;

   193

   194

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

   195

	InvalidateWindow(WC_FINANCES, pid);

   196

}

   197

   198

bool CheckPlayerHasMoney(CommandCost cost)

   199

{

   200

	if (cost.GetCost() > 0) {

   201

		PlayerID pid = _current_player;

   202

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

   203

			SetDParam(0, cost.GetCost());

   204

			_error_message = STR_0003_NOT_ENOUGH_CASH_REQUIRES;

   205

			return false;

   206

		}

   207

	}

   208

	return true;

   209

}

   210

   211

static void SubtractMoneyFromAnyPlayer(Player *p, CommandCost cost)

   212

{

   213

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

   214

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

   215

   216

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

   217

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

   218

   219

	if (HasBit(1 << EXPENSES_TRAIN_INC    |

   220

	           1 << EXPENSES_ROADVEH_INC  |

   221

	           1 << EXPENSES_AIRCRAFT_INC |

   222

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

   223

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

   224

	} else if (HasBit(1 << EXPENSES_TRAIN_RUN    |

   225

	                  1 << EXPENSES_ROADVEH_RUN  |

   226

	                  1 << EXPENSES_AIRCRAFT_RUN |

   227

	                  1 << EXPENSES_SHIP_RUN     |

   228

	                  1 << EXPENSES_PROPERTY     |

   229

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

   230

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

   231

	}

   232

   233

	InvalidatePlayerWindows(p);

   234

}

   235

   236

void SubtractMoneyFromPlayer(CommandCost cost)

   237

{

   238

	PlayerID pid = _current_player;

   239

   240

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

   241

}

   242

   243

void SubtractMoneyFromPlayerFract(PlayerID player, CommandCost cst)

   244

{

   245

	Player *p = GetPlayer(player);

   246

	byte m = p->player_money_fraction;

   247

	Money cost = cst.GetCost();

   248

   249

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

   250

	cost >>= 8;

   251

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

   252

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

   253

}

   254

   255

void GetNameOfOwner(Owner owner, TileIndex tile)

   256

{

   257

	SetDParam(2, owner);

   258

   259

	if (owner != OWNER_TOWN) {

   260

		if (!IsValidPlayer(owner)) {

   261

			SetDParam(0, STR_0150_SOMEONE);

   262

		} else {

   263

			const Player* p = GetPlayer(owner);

   264

   265

			SetDParam(0, STR_COMPANY_NAME);

   266

			SetDParam(1, p->index);

   267

		}

   268

	} else {

   269

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

   270

   271

		SetDParam(0, STR_TOWN);

   272

		SetDParam(1, t->index);

   273

	}

   274

}

   275

   276

   277

bool CheckOwnership(PlayerID owner)

   278

{

   279

	assert(owner < OWNER_END);

   280

   281

	if (owner == _current_player) return true;

   282

	_error_message = STR_013B_OWNED_BY;

   283

	GetNameOfOwner(owner, 0);

   284

	return false;

   285

}

   286

   287

bool CheckTileOwnership(TileIndex tile)

   288

{

   289

	Owner owner = GetTileOwner(tile);

   290

   291

	assert(owner < OWNER_END);

   292

   293

	if (owner == _current_player) return true;

   294

	_error_message = STR_013B_OWNED_BY;

   295

   296

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

   297

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

   298

	return false;

   299

}

   300

   301

static void GenerateCompanyName(Player *p)

   302

{

   303

	TileIndex tile;

   304

	Town *t;

   305

	StringID str;

   306

	Player *pp;

   307

	uint32 strp;

   308

	char buffer[100];

   309

   310

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

   311

   312

	tile = p->last_build_coordinate;

   313

	if (tile == 0) return;

   314

   315

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

   316

   317

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

   318

		str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_PLAYERNAME_START;

   319

		strp = t->townnameparts;

   320

   321

verify_name:;

   322

		/* No player must have this name already */

   323

		FOR_ALL_PLAYERS(pp) {

   324

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

   325

		}

   326

   327

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

   328

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

   329

			goto bad_town_name;

   330

   331

set_name:;

   332

		p->name_1 = str;

   333

		p->name_2 = strp;

   334

   335

		MarkWholeScreenDirty();

   336

   337

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

   338

			SetDParam(0, t->index);

   339

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

   340

		}

   341

		return;

   342

	}

   343

bad_town_name:;

   344

   345

	if (p->president_name_1 == SPECSTR_PRESIDENT_NAME) {

   346

		str = SPECSTR_ANDCO_NAME;

   347

		strp = p->president_name_2;

   348

		goto set_name;

   349

	} else {

   350

		str = SPECSTR_ANDCO_NAME;

   351

		strp = Random();

   352

		goto verify_name;

   353

	}

   354

}

   355

   356

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

   357

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

   358

	{ COLOUR_BLUE,       COLOUR_LIGHT_BLUE }, // COLOUR_DARK_BLUE

   359

	{ COLOUR_GREEN,      COLOUR_DARK_GREEN }, // COLOUR_PALE_GREEN

   360

	{ INVALID_COLOUR,    INVALID_COLOUR    }, // COLOUR_PINK

   361

	{ COLOUR_ORANGE,     INVALID_COLOUR    }, // COLOUR_YELLOW

   362

	{ INVALID_COLOUR,    INVALID_COLOUR    }, // COLOUR_RED

   363

	{ COLOUR_DARK_BLUE,  COLOUR_BLUE       }, // COLOUR_LIGHT_BLUE

   364

	{ COLOUR_PALE_GREEN, COLOUR_DARK_GREEN }, // COLOUR_GREEN

   365

	{ COLOUR_PALE_GREEN, COLOUR_GREEN      }, // COLOUR_DARK_GREEN

   366

	{ COLOUR_BLUE,       COLOUR_LIGHT_BLUE }, // COLOUR_BLUE

   367

	{ COLOUR_BROWN,      COLOUR_ORANGE     }, // COLOUR_CREAM

   368

	{ COLOUR_PURPLE,     INVALID_COLOUR    }, // COLOUR_MAUVE

   369

	{ COLOUR_MAUVE,      INVALID_COLOUR    }, // COLOUR_PURPLE

   370

	{ COLOUR_YELLOW,     COLOUR_CREAM      }, // COLOUR_ORANGE

   371

	{ COLOUR_CREAM,      INVALID_COLOUR    }, // COLOUR_BROWN

   372

	{ COLOUR_WHITE,      INVALID_COLOUR    }, // COLOUR_GREY

   373

	{ COLOUR_GREY,       INVALID_COLOUR    }, // COLOUR_WHITE

   374

};

   375

   376

static byte GeneratePlayerColour()

   377

{

   378

	Colours colours[COLOUR_END];

   379

   380

	/* Initialize array */

   381

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

   382

   383

	/* And randomize it */

   384

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

   385

		uint r = Random();

   386

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

   387

	}

   388

   389

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

   390

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

   391

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

   392

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

   393

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

   394

			}

   395

		}

   396

	};

   397

   398

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

   399

	Player *p;

   400

	FOR_ALL_PLAYERS(p) {

   401

		if (!p->is_active) continue;

   402

   403

		Colours pcolour = (Colours)p->player_color;

   404

   405

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

   406

			if (colours[i] == pcolour) {

   407

				colours[i] = INVALID_COLOUR;

   408

				break;

   409

			}

   410

		}

   411

   412

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

   413

			Colours similar = _similar_colour[pcolour][j];

   414

			if (similar == INVALID_COLOUR) break;

   415

   416

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

   417

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

   418

			}

   419

		}

   420

	}

   421

   422

	/* Return the first available color */

   423

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

   424

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

   425

	}

   426

   427

	NOT_REACHED();

   428

}

   429

   430

static void GeneratePresidentName(Player *p)

   431

{

   432

	Player *pp;

   433

	char buffer[100], buffer2[40];

   434

   435

	for (;;) {

   436

restart:;

   437

   438

		p->president_name_2 = Random();

   439

		p->president_name_1 = SPECSTR_PRESIDENT_NAME;

   440

   441

		SetDParam(0, p->index);

   442

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

   443

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

   444

			continue;

   445

   446

		FOR_ALL_PLAYERS(pp) {

   447

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

   448

				SetDParam(0, pp->index);

   449

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

   450

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

   451

					goto restart;

   452

			}

   453

		}

   454

		return;

   455

	}

   456

}

   457

   458

static Player *AllocatePlayer()

   459

{

   460

	Player *p;

   461

	/* Find a free slot */

   462

	FOR_ALL_PLAYERS(p) {

   463

		if (!p->is_active) {

   464

			PlayerID i = p->index;

   465

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

   466

			memset(&_players_ai[i], 0, sizeof(PlayerAI));

   467

			memset(&_players_ainew[i], 0, sizeof(PlayerAiNew));

   468

			p->index = i;

   469

			return p;

   470

		}

   471

	}

   472

	return NULL;

   473

}

   474

   475

void ResetPlayerLivery(Player *p)

   476

{

   477

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

   478

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

   479

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

   480

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

   481

	}

   482

}

   483

   484

/**

   485

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

   486

 *

   487

 * @param is_ai is a ai player?

   488

 * @return the player struct

   489

 */

   490

Player *DoStartupNewPlayer(bool is_ai)

   491

{