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

    35

#include "ai/trolly/trolly.h"

    36

#include "road_func.h"

    37

#include "rail.h"

    38

#include "sprite.h"

    39

#include "debug.h"

    40

    41

#include "table/strings.h"

    42

#include "table/sprites.h"

    43

    44

Player _players[MAX_PLAYERS];

    45

PlayerByte _local_player;

    46

PlayerByte _current_player;

    47

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

    48

byte _player_colors[MAX_PLAYERS];

    49

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

    50

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

    51

    52

/**

    53

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

    54

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

    55

 * @param new_player the new player

    56

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

    57

 */

    58

void SetLocalPlayer(PlayerID new_player)

    59

{

    60

	/* Player could also be PLAYER_SPECTATOR or OWNER_NONE */

    61

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

    62

    63

	_local_player = new_player;

    64

    65

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

    66

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

    67

		const Player *p = GetPlayer(new_player);

    68

		_settings_client.gui.autorenew        = p->engine_renew;

    69

		_settings_client.gui.autorenew_months = p->engine_renew_months;

    70

		_settings_client.gui.autorenew_money  = p->engine_renew_money;

    71

		InvalidateWindow(WC_GAME_OPTIONS, 0);

    72

	}

    73

}

    74

    75

bool IsHumanPlayer(PlayerID pi)

    76

{

    77

	return !GetPlayer(pi)->is_ai;

    78

}

    79

    80

    81

uint16 GetDrawStringPlayerColor(PlayerID player)

    82

{

    83

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

    84

	 * of the player */

    85

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

    86

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

    87

}

    88

    89

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

    90

{

    91

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

    92

}

    93

    94

/**

    95

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

    96

 *

    97

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

    98

 * - 4 and 5: chin

    99

 * - 6 to 9: eyebrows

   100

 * - 10 to 13: nose

   101

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

   102

 * - 16 to 19: hair

   103

 * - 20 to 22: eye color

   104

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

   105

 * - 28 to 30: glasses

   106

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

   107

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

   108

 *

   109

 * @param face the face in the old format

   110

 * @return the face in the new format

   111

 */

   112

PlayerFace ConvertFromOldPlayerFace(uint32 face)

   113

{

   114

	PlayerFace pf = 0;

   115

	GenderEthnicity ge = GE_WM;

   116

   117

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

   118

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

   119

   120

	SetPlayerFaceBits(pf, PFV_GEN_ETHN,    ge, ge);

   121

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

   122

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

   123

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

   124

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

   125

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

   126

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

   127

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

   128

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

   129

   130

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

   131

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

   132

		SetPlayerFaceBits(pf, PFV_HAS_MOUSTACHE, ge, true);

   133

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

   134

	} else {

   135

		if (!HasBit(ge, GENDER_FEMALE)) {

   136

			lips = lips * 15 / 16;

   137

			lips -= 3;

   138

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

   139

		} else {

   140

			lips = ScalePlayerFaceValue(PFV_LIPS, ge, lips);

   141

		}

   142

		SetPlayerFaceBits(pf, PFV_LIPS, ge, lips);

   143

   144

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

   145

		if (ge == GE_WF) {

   146

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

   147

		} else {

   148

			nose = ScalePlayerFaceValue(PFV_NOSE, ge, nose);

   149

		}

   150

		SetPlayerFaceBits(pf, PFV_NOSE, ge, nose);

   151

	}

   152

   153

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

   154

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

   155

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

   156

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

   157

	}

   158

   159

	return pf;

   160

}

   161

   162

/**

   163

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

   164

 * Unused bits are not enforced to be 0.

   165

 * @param pf the fact to check

   166

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

   167

 */

   168

bool IsValidPlayerFace(PlayerFace pf)

   169

{

   170

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

   171

   172

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

   173

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

   174

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

   175

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

   176

   177

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

   178

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

   179

		switch (pfv) {

   180

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

   181

			case PFV_LIPS:        /* FALL THROUGH */

   182

			case PFV_NOSE:        if (has_moustache)    continue; break;

   183

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

   184

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

   185

			default: break;

   186

		}

   187

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

   188

	}

   189

   190

	return true;

   191

}

   192

   193

void InvalidatePlayerWindows(const Player *p)

   194

{

   195

	PlayerID pid = p->index;

   196

   197

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

   198

	InvalidateWindow(WC_FINANCES, pid);

   199

}

   200

   201

bool CheckPlayerHasMoney(CommandCost cost)

   202

{

   203

	if (cost.GetCost() > 0) {

   204

		PlayerID pid = _current_player;

   205

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

   206

			SetDParam(0, cost.GetCost());

   207

			_error_message = STR_0003_NOT_ENOUGH_CASH_REQUIRES;

   208

			return false;

   209

		}

   210

	}

   211

	return true;

   212

}

   213

   214

/** Backs up current economic data for a player

   215

 */

   216

PlayerMoneyBackup::PlayerMoneyBackup(Player *player)

   217

{

   218

	p = player;

   219

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

   220

	backup_cur_economy = p->cur_economy;

   221

}

   222

   223

/** Restore the economic data from last backup

   224

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

   225

 */

   226

void PlayerMoneyBackup::Restore()

   227

{

   228

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

   229

	p->cur_economy = backup_cur_economy;

   230

}

   231

   232

static void SubtractMoneyFromAnyPlayer(Player *p, CommandCost cost)

   233

{

   234

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

   235

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

   236

   237

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

   238

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

   239

   240

	if (HasBit(1 << EXPENSES_TRAIN_INC    |

   241

	           1 << EXPENSES_ROADVEH_INC  |

   242

	           1 << EXPENSES_AIRCRAFT_INC |

   243

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

   244

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

   245

	} else if (HasBit(1 << EXPENSES_TRAIN_RUN    |

   246

	                  1 << EXPENSES_ROADVEH_RUN  |

   247

	                  1 << EXPENSES_AIRCRAFT_RUN |

   248

	                  1 << EXPENSES_SHIP_RUN     |

   249

	                  1 << EXPENSES_PROPERTY     |

   250

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

   251

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

   252

	}

   253

   254

	InvalidatePlayerWindows(p);

   255

}

   256

   257

void SubtractMoneyFromPlayer(CommandCost cost)

   258

{

   259

	PlayerID pid = _current_player;

   260

   261

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

   262

}

   263

   264

void SubtractMoneyFromPlayerFract(PlayerID player, CommandCost cst)

   265

{

   266

	Player *p = GetPlayer(player);

   267

	byte m = p->player_money_fraction;

   268

	Money cost = cst.GetCost();

   269

   270

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

   271

	cost >>= 8;

   272

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

   273

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

   274

}

   275

   276

void GetNameOfOwner(Owner owner, TileIndex tile)

   277

{

   278

	SetDParam(2, owner);

   279

   280

	if (owner != OWNER_TOWN) {

   281

		if (!IsValidPlayer(owner)) {

   282

			SetDParam(0, STR_0150_SOMEONE);

   283

		} else {

   284

			const Player* p = GetPlayer(owner);

   285

   286

			SetDParam(0, STR_COMPANY_NAME);

   287

			SetDParam(1, p->index);

   288

		}

   289

	} else {

   290

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

   291

   292

		SetDParam(0, STR_TOWN);

   293

		SetDParam(1, t->index);

   294

	}

   295

}

   296

   297

   298

bool CheckOwnership(PlayerID owner)

   299

{

   300

	assert(owner < OWNER_END);

   301

   302

	if (owner == _current_player) return true;

   303

	_error_message = STR_013B_OWNED_BY;

   304

	GetNameOfOwner(owner, 0);

   305

	return false;

   306

}

   307

   308

bool CheckTileOwnership(TileIndex tile)

   309

{

   310

	Owner owner = GetTileOwner(tile);

   311

   312

	assert(owner < OWNER_END);

   313

   314

	if (owner == _current_player) return true;

   315

	_error_message = STR_013B_OWNED_BY;

   316

   317

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

   318

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

   319

	return false;

   320

}

   321

   322

static void GenerateCompanyName(Player *p)

   323

{

   324

	TileIndex tile;

   325

	Town *t;

   326

	StringID str;

   327

	Player *pp;

   328

	uint32 strp;

   329

	char buffer[100];

   330

   331

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

   332

   333

	tile = p->last_build_coordinate;

   334

	if (tile == 0) return;

   335

   336

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

   337

   338

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

   339

		str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_PLAYERNAME_START;

   340

		strp = t->townnameparts;

   341

   342

verify_name:;

   343

		/* No player must have this name already */

   344

		FOR_ALL_PLAYERS(pp) {

   345

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

   346

		}

   347

   348

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

   349

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

   350

			goto bad_town_name;

   351

   352

set_name:;

   353

		p->name_1 = str;

   354

		p->name_2 = strp;

   355

   356

		MarkWholeScreenDirty();

   357

   358

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

   359

			SetDParam(0, STR_705E_NEW_TRANSPORT_COMPANY_LAUNCHED);

   360

			SetDParam(1, STR_705F_STARTS_CONSTRUCTION_NEAR);

   361

			SetDParam(2, p->index);

   362

			SetDParam(3, t->index);

   363

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

   364

		}

   365

		return;

   366

	}

   367

bad_town_name:;

   368

   369

	if (p->president_name_1 == SPECSTR_PRESIDENT_NAME) {

   370

		str = SPECSTR_ANDCO_NAME;

   371

		strp = p->president_name_2;

   372

		goto set_name;

   373

	} else {

   374

		str = SPECSTR_ANDCO_NAME;

   375

		strp = Random();

   376

		goto verify_name;

   377

	}

   378

}

   379

   380

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

   381

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

   382

	{ COLOUR_BLUE,       COLOUR_LIGHT_BLUE }, // COLOUR_DARK_BLUE

   383

	{ COLOUR_GREEN,      COLOUR_DARK_GREEN }, // COLOUR_PALE_GREEN

   384

	{ INVALID_COLOUR,    INVALID_COLOUR    }, // COLOUR_PINK

   385

	{ COLOUR_ORANGE,     INVALID_COLOUR    }, // COLOUR_YELLOW

   386

	{ INVALID_COLOUR,    INVALID_COLOUR    }, // COLOUR_RED

   387

	{ COLOUR_DARK_BLUE,  COLOUR_BLUE       }, // COLOUR_LIGHT_BLUE

   388

	{ COLOUR_PALE_GREEN, COLOUR_DARK_GREEN }, // COLOUR_GREEN

   389

	{ COLOUR_PALE_GREEN, COLOUR_GREEN      }, // COLOUR_DARK_GREEN

   390

	{ COLOUR_BLUE,       COLOUR_LIGHT_BLUE }, // COLOUR_BLUE

   391

	{ COLOUR_BROWN,      COLOUR_ORANGE     }, // COLOUR_CREAM

   392

	{ COLOUR_PURPLE,     INVALID_COLOUR    }, // COLOUR_MAUVE

   393

	{ COLOUR_MAUVE,      INVALID_COLOUR    }, // COLOUR_PURPLE

   394

	{ COLOUR_YELLOW,     COLOUR_CREAM      }, // COLOUR_ORANGE

   395

	{ COLOUR_CREAM,      INVALID_COLOUR    }, // COLOUR_BROWN

   396

	{ COLOUR_WHITE,      INVALID_COLOUR    }, // COLOUR_GREY

   397

	{ COLOUR_GREY,       INVALID_COLOUR    }, // COLOUR_WHITE

   398

};

   399

   400

static byte GeneratePlayerColour()

   401

{

   402

	Colours colours[COLOUR_END];

   403

   404

	/* Initialize array */

   405

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

   406

   407

	/* And randomize it */

   408

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

   409

		uint r = Random();

   410

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

   411

	}

   412

   413

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

   414

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

   415

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

   416

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

   417

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

   418

			}

   419

		}

   420

	};

   421

   422

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

   423

	Player *p;

   424

	FOR_ALL_PLAYERS(p) {

   425

		if (!p->is_active) continue;

   426

   427

		Colours pcolour = (Colours)p->player_color;

   428

   429

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

   430

			if (colours[i] == pcolour) {

   431

				colours[i] = INVALID_COLOUR;

   432

				break;

   433

			}

   434

		}

   435

   436

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

   437

			Colours similar = _similar_colour[pcolour][j];

   438

			if (similar == INVALID_COLOUR) break;

   439

   440

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

   441

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

   442

			}

   443

		}

   444

	}

   445

   446

	/* Return the first available color */

   447

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

   448

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

   449

	}

   450

   451

	NOT_REACHED();

   452

}

   453

   454

static void GeneratePresidentName(Player *p)

   455

{

   456

	Player *pp;

   457

	char buffer[100], buffer2[40];

   458

   459

	for (;;) {

   460

restart:;

   461

   462

		p->president_name_2 = Random();

   463

		p->president_name_1 = SPECSTR_PRESIDENT_NAME;

   464

   465

		SetDParam(0, p->index);

   466

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

   467

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

   468

			continue;

   469

   470

		FOR_ALL_PLAYERS(pp) {

   471

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

   472

				SetDParam(0, pp->index);

   473

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

   474

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

   475

					goto restart;

   476

			}

   477

		}

   478

		return;

   479

	}

   480

}

   481

   482

static Player *AllocatePlayer()

   483

{

   484

	Player *p;

   485

	/* Find a free slot */

   486

	FOR_ALL_PLAYERS(p) {

   487

		if (!p->is_active) {

   488

			free(p->name);

   489

			free(p->president_name);

   490

			PlayerID i = p->index;

   491