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

    18

#include "player_face.h"

    19

#include "group.h"

    20

#include "window_func.h"

    21

#include "tile_map.h"

    22

#include "strings_func.h"

    23

#include "gfx_func.h"

    24

#include "functions.h"

    25

#include "date_func.h"

    26

#include "vehicle_func.h"

    27

#include "sound_func.h"

    28

#include "autoreplace_func.h"

    29

#include "autoreplace_gui.h"

    30

#include "string_func.h"

    31

#include "road_func.h"

    32

#include "rail.h"

    33

#include "settings_type.h"

    34

#include "sprite.h"

    35

    36

#include "table/strings.h"

    37

#include "table/sprites.h"

    38

    39

Player _players[MAX_PLAYERS];

    40

PlayerByte _local_player;

    41

PlayerByte _current_player;

    42

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

    43

byte _player_colors[MAX_PLAYERS];

    44

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

    45

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

    46

    47

/**

    48

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

    49

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

    50

 * @param new_player the new player

    51

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

    52

 */

    53

void SetLocalPlayer(PlayerID new_player)

    54

{

    55

	/* Player could also be PLAYER_SPECTATOR or OWNER_NONE */

    56

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

    57

    58

	_local_player = new_player;

    59

    60

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

    61

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

    62

		const Player *p = GetPlayer(new_player);

    63

		_patches.autorenew        = p->engine_renew;

    64

		_patches.autorenew_months = p->engine_renew_months;

    65

		_patches.autorenew_money  = p->engine_renew_money;

    66

		InvalidateWindow(WC_GAME_OPTIONS, 0);

    67

	}

    68

}

    69

    70

bool IsHumanPlayer(PlayerID pi)

    71

{

    72

	return !GetPlayer(pi)->is_ai;

    73

}

    74

    75

    76

uint16 GetDrawStringPlayerColor(PlayerID player)

    77

{

    78

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

    79

	 * of the player */

    80

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

    81

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

    82

}

    83

    84

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

    85

{

    86

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

    87

}

    88

    89

/**

    90

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

    91

 *

    92

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

    93

 * - 4 and 5: chin

    94

 * - 6 to 9: eyebrows

    95

 * - 10 to 13: nose

    96

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

    97

 * - 16 to 19: hair

    98

 * - 20 to 22: eye color

    99

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

   100

 * - 28 to 30: glasses

   101

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

   102

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

   103

 *

   104

 * @param face the face in the old format

   105

 * @return the face in the new format

   106

 */

   107

PlayerFace ConvertFromOldPlayerFace(uint32 face)

   108

{

   109

	PlayerFace pf = 0;

   110

	GenderEthnicity ge = GE_WM;

   111

   112

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

   113

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

   114

   115

	SetPlayerFaceBits(pf, PFV_GEN_ETHN,    ge, ge);

   116

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

   117

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

   118

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

   119

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

   120

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

   121

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

   122

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

   123

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

   124

   125

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

   126

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

   127

		SetPlayerFaceBits(pf, PFV_HAS_MOUSTACHE, ge, true);

   128

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

   129

	} else {

   130

		if (!HasBit(ge, GENDER_FEMALE)) {

   131

			lips = lips * 15 / 16;

   132

			lips -= 3;

   133

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

   134

		} else {

   135

			lips = ScalePlayerFaceValue(PFV_LIPS, ge, lips);

   136

		}

   137

		SetPlayerFaceBits(pf, PFV_LIPS, ge, lips);

   138

   139

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

   140

		if (ge == GE_WF) {

   141

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

   142

		} else {

   143

			nose = ScalePlayerFaceValue(PFV_NOSE, ge, nose);

   144

		}

   145

		SetPlayerFaceBits(pf, PFV_NOSE, ge, nose);

   146

	}

   147

   148

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

   149

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

   150

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

   151

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

   152

	}

   153

   154

	return pf;

   155

}

   156

   157

/**

   158

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

   159

 * Unused bits are not enforced to be 0.

   160

 * @param pf the fact to check

   161

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

   162

 */

   163

bool IsValidPlayerFace(PlayerFace pf)

   164

{

   165

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

   166

   167

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

   168

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

   169

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

   170

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

   171

   172

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

   173

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

   174

		switch (pfv) {

   175

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

   176

			case PFV_LIPS:        /* FALL THROUGH */

   177

			case PFV_NOSE:        if (has_moustache)    continue; break;

   178

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

   179

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

   180

			default: break;

   181

		}

   182

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

   183

	}

   184

   185

	return true;

   186

}

   187

   188

void InvalidatePlayerWindows(const Player *p)

   189

{

   190

	PlayerID pid = p->index;

   191

   192

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

   193

	InvalidateWindow(WC_FINANCES, pid);

   194

}

   195

   196

bool CheckPlayerHasMoney(CommandCost cost)

   197

{

   198

	if (cost.GetCost() > 0) {

   199

		PlayerID pid = _current_player;

   200

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

   201

			SetDParam(0, cost.GetCost());

   202

			_error_message = STR_0003_NOT_ENOUGH_CASH_REQUIRES;

   203

			return false;

   204

		}

   205

	}

   206

	return true;

   207

}

   208

   209

static void SubtractMoneyFromAnyPlayer(Player *p, CommandCost cost)

   210

{

   211

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

   212

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

   213

   214

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

   215

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

   216

   217

	if (HasBit(1 << EXPENSES_TRAIN_INC    |

   218

	           1 << EXPENSES_ROADVEH_INC  |

   219

	           1 << EXPENSES_AIRCRAFT_INC |

   220

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

   221

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

   222

	} else if (HasBit(1 << EXPENSES_TRAIN_RUN    |

   223

	                  1 << EXPENSES_ROADVEH_RUN  |

   224

	                  1 << EXPENSES_AIRCRAFT_RUN |

   225

	                  1 << EXPENSES_SHIP_RUN     |

   226

	                  1 << EXPENSES_PROPERTY     |

   227

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

   228

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

   229

	}

   230

   231

	InvalidatePlayerWindows(p);

   232

}

   233

   234

void SubtractMoneyFromPlayer(CommandCost cost)

   235

{

   236

	PlayerID pid = _current_player;

   237

   238

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

   239

}

   240

   241

void SubtractMoneyFromPlayerFract(PlayerID player, CommandCost cst)

   242

{

   243

	Player *p = GetPlayer(player);

   244

	byte m = p->player_money_fraction;

   245

	Money cost = cst.GetCost();

   246

   247

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

   248

	cost >>= 8;

   249

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

   250

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

   251

}

   252

   253

void GetNameOfOwner(Owner owner, TileIndex tile)

   254

{

   255

	SetDParam(2, owner);

   256

   257

	if (owner != OWNER_TOWN) {

   258

		if (!IsValidPlayer(owner)) {

   259

			SetDParam(0, STR_0150_SOMEONE);

   260

		} else {

   261

			const Player* p = GetPlayer(owner);

   262

   263

			SetDParam(0, STR_COMPANY_NAME);

   264

			SetDParam(1, p->index);

   265

		}

   266

	} else {

   267

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

   268

   269

		SetDParam(0, STR_TOWN);

   270

		SetDParam(1, t->index);

   271

	}

   272

}

   273

   274

   275

bool CheckOwnership(PlayerID owner)

   276

{

   277

	assert(owner < OWNER_END);

   278

   279

	if (owner == _current_player) return true;

   280

	_error_message = STR_013B_OWNED_BY;

   281

	GetNameOfOwner(owner, 0);

   282

	return false;

   283

}

   284

   285

bool CheckTileOwnership(TileIndex tile)

   286

{

   287

	Owner owner = GetTileOwner(tile);

   288

   289

	assert(owner < OWNER_END);

   290

   291

	if (owner == _current_player) return true;

   292

	_error_message = STR_013B_OWNED_BY;

   293

   294

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

   295

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

   296

	return false;

   297

}

   298

   299

static void GenerateCompanyName(Player *p)

   300

{

   301

	TileIndex tile;

   302

	Town *t;

   303

	StringID str;

   304

	Player *pp;

   305

	uint32 strp;

   306

	char buffer[100];

   307

   308

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

   309

   310

	tile = p->last_build_coordinate;

   311

	if (tile == 0) return;

   312

   313

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

   314

   315

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

   316

		str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_PLAYERNAME_START;

   317

		strp = t->townnameparts;

   318

   319

verify_name:;

   320

		/* No player must have this name already */

   321

		FOR_ALL_PLAYERS(pp) {

   322

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

   323

		}

   324

   325

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

   326

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

   327

			goto bad_town_name;

   328

   329

set_name:;

   330

		p->name_1 = str;

   331

		p->name_2 = strp;

   332

   333

		MarkWholeScreenDirty();

   334

   335

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

   336

			SetDParam(0, t->index);

   337

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

   338

		}

   339

		return;

   340

	}

   341

bad_town_name:;

   342

   343

	if (p->president_name_1 == SPECSTR_PRESIDENT_NAME) {

   344

		str = SPECSTR_ANDCO_NAME;

   345

		strp = p->president_name_2;

   346

		goto set_name;

   347

	} else {

   348

		str = SPECSTR_ANDCO_NAME;

   349

		strp = Random();

   350

		goto verify_name;

   351

	}

   352

}

   353

   354

#define COLOR_SWAP(i,j) do { byte t=colors[i];colors[i]=colors[j];colors[j]=t; } while(0)

   355

   356

static const byte _color_sort[16] = {2, 2, 3, 2, 3, 2, 3, 2, 3, 2, 2, 2, 3, 1, 1, 1};

   357

static const byte _color_similar_1[16] = {8, 6, 255, 12,  255, 0, 1, 1, 0, 13,  11,  10, 3,   9,  15, 14};

   358

static const byte _color_similar_2[16] = {5, 7, 255, 255, 255, 8, 7, 6, 5, 12, 255, 255, 9, 255, 255, 255};

   359

   360

static byte GeneratePlayerColor()

   361

{

   362

	byte colors[16], pcolor, t2;

   363

	int i,j,n;

   364

	uint32 r;

   365

	Player *p;

   366

   367

	/* Initialize array */

   368

	for (i = 0; i != 16; i++) colors[i] = i;

   369

   370

	/* And randomize it */

   371

	n = 100;

   372

	do {

   373

		r = Random();

   374

		COLOR_SWAP(GB(r, 0, 4), GB(r, 4, 4));

   375

	} while (--n);

   376

   377

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

   378

	i = 16;

   379

	do {

   380

		for (j = 0; j != 15; j++) {

   381

			if (_color_sort[colors[j]] < _color_sort[colors[j + 1]]) {

   382

				COLOR_SWAP(j, j + 1);

   383

			}

   384

		}

   385

	} while (--i);

   386

   387

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

   388

	FOR_ALL_PLAYERS(p) if (p->is_active) {

   389

		pcolor = p->player_color;

   390

		for (i=0; i!=16; i++) if (colors[i] == pcolor) {

   391

			colors[i] = 0xFF;

   392

   393

			t2 = _color_similar_1[pcolor];

   394

			if (t2 == 0xFF) break;

   395

			for (i=0; i!=15; i++) {

   396

				if (colors[i] == t2) {

   397

					do COLOR_SWAP(i,i+1); while (++i != 15);

   398

					break;

   399

				}

   400

			}

   401

   402

			t2 = _color_similar_2[pcolor];

   403

			if (t2 == 0xFF) break;

   404

			for (i = 0; i != 15; i++) {

   405

				if (colors[i] == t2) {

   406

					do COLOR_SWAP(i, i + 1); while (++i != 15);

   407

					break;

   408

				}

   409

			}

   410

			break;

   411

		}

   412

	}

   413

   414

	/* Return the first available color */

   415

	for (i = 0;; i++) {

   416

		if (colors[i] != 0xFF) return colors[i];

   417

	}

   418

}

   419

   420

static void GeneratePresidentName(Player *p)

   421

{

   422

	Player *pp;

   423

	char buffer[100], buffer2[40];

   424

   425

	for (;;) {

   426

restart:;

   427

   428

		p->president_name_2 = Random();

   429

		p->president_name_1 = SPECSTR_PRESIDENT_NAME;

   430

   431

		SetDParam(0, p->index);

   432

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

   433

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

   434

			continue;

   435

   436

		FOR_ALL_PLAYERS(pp) {

   437

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

   438

				SetDParam(0, pp->index);

   439

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

   440

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

   441

					goto restart;

   442

			}

   443

		}

   444

		return;

   445

	}

   446

}

   447

   448

static Player *AllocatePlayer()

   449

{

   450

	Player *p;

   451

	/* Find a free slot */

   452

	FOR_ALL_PLAYERS(p) {

   453

		if (!p->is_active) {

   454

			PlayerID i = p->index;

   455

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

   456

			p->index = i;

   457

			p->is_noai = true;

   458

			return p;

   459

		}

   460

	}

   461

	return NULL;

   462

}

   463

   464

void ResetPlayerLivery(Player *p)

   465

{

   466

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

   467

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

   468

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

   469

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

   470

	}

   471

}

   472

   473

/**

   474

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

   475

 *

   476

 * @param is_ai is a ai player?

   477

 * @return the player struct

   478

 */

   479

Player *DoStartupNewPlayer(bool is_ai)

   480

{

   481

	Player *p;

   482

   483

	p = AllocatePlayer();

   484

	if (p == NULL) return NULL;

   485

   486

	/* Make a color */

   487

	p->player_color = GeneratePlayerColor();

   488

	ResetPlayerLivery(p);

   489

	_player_colors[p->index] = p->player_color;

   490

	p->name_1 = STR_SV_UNNAMED;

   491

	p->is_active = true;

   492

   493

	p->player_money = p->current_loan = 100000;