1

/* $Id$ */

     2

     3

/** @file players.cpp

     4

 */

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "engine.h"

     8

#include "functions.h"

     9

#include "string.h"

    10

#include "strings.h"

    11

#include "table/strings.h"

    12

#include "table/sprites.h"

    13

#include "map.h"

    14

#include "player.h"

    15

#include "town.h"

    16

#include "vehicle.h"

    17

#include "station.h"

    18

#include "gfx.h"

    19

#include "news.h"

    20

#include "saveload.h"

    21

#include "command.h"

    22

#include "sound.h"

    23

#include "network/network.h"

    24

#include "variables.h"

    25

#include "engine.h"

    26

#include "ai/ai.h"

    27

#include "date.h"

    28

#include "window.h"

    29

#include "player_face.h"

    30

#include "group.h"

    31

    32

/**

    33

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

    34

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

    35

 * @param new_player the new player

    36

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

    37

 */

    38

void SetLocalPlayer(PlayerID new_player)

    39

{

    40

	/* Player could also be PLAYER_SPECTATOR or OWNER_NONE */

    41

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

    42

    43

	_local_player = new_player;

    44

    45

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

    46

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

    47

		const Player *p = GetPlayer(new_player);

    48

		_patches.autorenew        = p->engine_renew;

    49

		_patches.autorenew_months = p->engine_renew_months;

    50

		_patches.autorenew_money  = p->engine_renew_money;

    51

		InvalidateWindow(WC_GAME_OPTIONS, 0);

    52

	}

    53

}

    54

    55

    56

uint16 GetDrawStringPlayerColor(PlayerID player)

    57

{

    58

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

    59

	 * of the player */

    60

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

    61

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

    62

}

    63

    64

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

    65

{

    66

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

    67

}

    68

    69

/**

    70

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

    71

 *

    72

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

    73

 * - 4 and 5: chin

    74

 * - 6 to 9: eyebrows

    75

 * - 10 to 13: nose

    76

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

    77

 * - 16 to 19: hair

    78

 * - 20 to 22: eye color

    79

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

    80

 * - 28 to 30: glasses

    81

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

    82

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

    83

 *

    84

 * @param face the face in the old format

    85

 * @return the face in the new format

    86

 */

    87

PlayerFace ConvertFromOldPlayerFace(uint32 face)

    88

{

    89

	PlayerFace pf = 0;

    90

	GenderEthnicity ge = GE_WM;

    91

    92

	if (HASBIT(face, 31)) SetBitT(ge, GENDER_FEMALE);

    93

	if (HASBIT(face, 27) && (HASBIT(face, 26) == HASBIT(face, 19))) SetBitT(ge, ETHNICITY_BLACK);

    94

    95

	SetPlayerFaceBits(pf, PFV_GEN_ETHN,    ge, ge);

    96

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

    97

	SetPlayerFaceBits(pf, PFV_EYE_COLOUR,  ge, clampu(GB(face, 20, 3), 5, 7) - 5);

    98

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

    99

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

   100

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

   101

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

   102

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

   103

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

   104

   105

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

   106

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

   107

		SetPlayerFaceBits(pf, PFV_HAS_MOUSTACHE, ge, true);

   108

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

   109

	} else {

   110

		if (!HASBIT(ge, GENDER_FEMALE)) {

   111

			lips = lips * 15 / 16;

   112

			lips -= 3;

   113

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

   114

		} else {

   115

			lips = ScalePlayerFaceValue(PFV_LIPS, ge, lips);

   116

		}

   117

		SetPlayerFaceBits(pf, PFV_LIPS, ge, lips);

   118

   119

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

   120

		if (ge == GE_WF) {

   121

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

   122

		} else {

   123

			nose = ScalePlayerFaceValue(PFV_NOSE, ge, nose);

   124

		}

   125

		SetPlayerFaceBits(pf, PFV_NOSE, ge, nose);

   126

	}

   127

   128

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

   129

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

   130

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

   131

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

   132

	}

   133

   134

	return pf;

   135

}

   136

   137

/**

   138

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

   139

 * Unused bits are not enforced to be 0.

   140

 * @param pf the fact to check

   141

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

   142

 */

   143

bool IsValidPlayerFace(PlayerFace pf)

   144

{

   145

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

   146

   147

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

   148

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

   149

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

   150

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

   151

   152

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

   153

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

   154

		switch (pfv) {

   155

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

   156

			case PFV_LIPS:        /* FALL THROUGH */

   157

			case PFV_NOSE:        if (has_moustache)    continue; break;

   158

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

   159

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

   160

			default: break;

   161

		}

   162

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

   163

	}

   164

   165

	return true;

   166

}

   167

   168

void InvalidatePlayerWindows(const Player *p)

   169

{

   170

	PlayerID pid = p->index;

   171

   172

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

   173

	InvalidateWindow(WC_FINANCES, pid);

   174

}

   175

   176

bool CheckPlayerHasMoney(CommandCost cost)

   177

{

   178

	if (cost.GetCost() > 0) {

   179

		PlayerID pid = _current_player;

   180

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

   181

			SetDParam(0, cost.GetCost());

   182

			_error_message = STR_0003_NOT_ENOUGH_CASH_REQUIRES;

   183

			return false;

   184

		}

   185

	}

   186

	return true;

   187

}

   188

   189

static void SubtractMoneyFromAnyPlayer(Player *p, CommandCost cost)

   190

{

   192

	tmp.AddCost(-cost.GetCost());

   193

	p->player_money = tmp.GetCost();

   194

   196

	tmp.AddCost(cost);

   197

	p->yearly_expenses[0][_yearly_expenses_type] = tmp.GetCost();

   198

   199

	if (HASBIT(1 << EXPENSES_TRAIN_INC    |

   200

	           1 << EXPENSES_ROADVEH_INC  |

   201

	           1 << EXPENSES_AIRCRAFT_INC |

   202

	           1 << EXPENSES_SHIP_INC, _yearly_expenses_type)) {

   203

		tmp = CommandCost(p->cur_economy.income);

   204

		tmp.AddCost(-cost.GetCost());

   205

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

   206

	} else if (HASBIT(1 << EXPENSES_TRAIN_RUN    |

   207

	                  1 << EXPENSES_ROADVEH_RUN  |

   208

	                  1 << EXPENSES_AIRCRAFT_RUN |

   209

	                  1 << EXPENSES_SHIP_RUN     |

   210

	                  1 << EXPENSES_PROPERTY     |

   211

	                  1 << EXPENSES_LOAN_INT, _yearly_expenses_type)) {

   212

		tmp = CommandCost(p->cur_economy.expenses);

   213

		tmp.AddCost(-cost.GetCost());

   214

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

   215

	}

   216

   217

	InvalidatePlayerWindows(p);

   218

}

   219

   220

void SubtractMoneyFromPlayer(CommandCost cost)

   221

{

   222

	PlayerID pid = _current_player;

   223

   224

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

   225

}

   226

   227

void SubtractMoneyFromPlayerFract(PlayerID player, CommandCost cst)

   228

{

   229

	Player *p = GetPlayer(player);

   230

	byte m = p->player_money_fraction;

   231

	Money cost = cst.GetCost();

   232

   233

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

   234

	cost >>= 8;

   235

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

   236

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

   237

}

   238

   239

void GetNameOfOwner(Owner owner, TileIndex tile)

   240

{

   241

	SetDParam(2, owner);

   242

   243

	if (owner != OWNER_TOWN) {

   244

		if (!IsValidPlayer(owner)) {

   245

			SetDParam(0, STR_0150_SOMEONE);

   246

		} else {

   247

			const Player* p = GetPlayer(owner);

   248

   249

			SetDParam(0, p->name_1);

   250

			SetDParam(1, p->name_2);

   251

		}

   252

	} else {

   253

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

   254

   255

		SetDParam(0, STR_TOWN);

   256

		SetDParam(1, t->index);

   257

	}

   258

}

   259

   260

   261

bool CheckOwnership(PlayerID owner)

   262

{

   263

	assert(owner < OWNER_END);

   264

   265

	if (owner == _current_player) return true;

   266

	_error_message = STR_013B_OWNED_BY;

   267

	GetNameOfOwner(owner, 0);

   268

	return false;

   269

}

   270

   271

bool CheckTileOwnership(TileIndex tile)

   272

{

   273

	Owner owner = GetTileOwner(tile);

   274

   275

	assert(owner < OWNER_END);

   276

   277

	if (owner == _current_player) return true;

   278

	_error_message = STR_013B_OWNED_BY;

   279

   280

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

   281

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

   282

	return false;

   283

}

   284

   285

static void GenerateCompanyName(Player *p)

   286

{

   287

	TileIndex tile;

   288

	Town *t;

   289

	StringID str;

   290

	Player *pp;

   291

	uint32 strp;

   292

	char buffer[100];

   293

   294

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

   295

   296

	tile = p->last_build_coordinate;

   297

	if (tile == 0) return;

   298

   299

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

   300

   301

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

   302

		str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_PLAYERNAME_START;

   303

		strp = t->townnameparts;

   304

   305

verify_name:;

   306

		/* No player must have this name already */

   307

		FOR_ALL_PLAYERS(pp) {

   308

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

   309

		}

   310

   311

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

   312

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

   313

			goto bad_town_name;

   314

   315

set_name:;

   316

		p->name_1 = str;

   317

		p->name_2 = strp;

   318

   319

		MarkWholeScreenDirty();

   320

   321

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

   322

			SetDParam(0, t->index);

   323

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

   324

		}

   325

		return;

   326

	}

   327

bad_town_name:;

   328

   329

	if (p->president_name_1 == SPECSTR_PRESIDENT_NAME) {

   330

		str = SPECSTR_ANDCO_NAME;

   331

		strp = p->president_name_2;

   332

		goto set_name;

   333

	} else {

   334

		str = SPECSTR_ANDCO_NAME;

   335

		strp = Random();

   336

		goto verify_name;

   337

	}

   338

}

   339

   340

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

   341

   342

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

   343

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

   344

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

   345

   346

static byte GeneratePlayerColor()

   347

{

   348

	byte colors[16], pcolor, t2;

   349

	int i,j,n;

   350

	uint32 r;

   351

	Player *p;

   352

   353

	/* Initialize array */

   354

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

   355

   356

	/* And randomize it */

   357

	n = 100;

   358

	do {

   359

		r = Random();

   360

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

   361

	} while (--n);

   362

   363

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

   364

	i = 16;

   365

	do {

   366

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

   367

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

   368

				COLOR_SWAP(j, j + 1);

   369

			}

   370

		}

   371

	} while (--i);

   372

   373

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

   374

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

   375

		pcolor = p->player_color;

   376

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

   377

			colors[i] = 0xFF;

   378

   379

			t2 = _color_similar_1[pcolor];

   380

			if (t2 == 0xFF) break;

   381

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

   382

				if (colors[i] == t2) {

   383

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

   384

					break;

   385

				}

   386

			}

   387

   388

			t2 = _color_similar_2[pcolor];

   389

			if (t2 == 0xFF) break;

   390

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

   391

				if (colors[i] == t2) {

   392

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

   393

					break;

   394

				}

   395

			}

   396

			break;

   397

		}

   398

	}

   399

   400

	/* Return the first available color */

   401

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

   402

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

   403

	}

   404

}

   405

   406

static void GeneratePresidentName(Player *p)

   407

{

   408

	Player *pp;

   409

	char buffer[100], buffer2[40];

   410

   411

	for (;;) {

   412

restart:;

   413

   414

		p->president_name_2 = Random();

   415

		p->president_name_1 = SPECSTR_PRESIDENT_NAME;

   416

   417

		SetDParam(0, p->president_name_2);

   418

		GetString(buffer, p->president_name_1, lastof(buffer));

   419

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

   420

			continue;

   421

   422

		FOR_ALL_PLAYERS(pp) {

   423

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

   424

				SetDParam(0, pp->president_name_2);

   425

				GetString(buffer2, pp->president_name_1, lastof(buffer2));

   426

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

   427

					goto restart;

   428

			}

   429

		}

   430

		return;

   431

	}

   432

}

   433

   434

static Player *AllocatePlayer()

   435

{

   436

	Player *p;

   437

	/* Find a free slot */

   438

	FOR_ALL_PLAYERS(p) {

   439

		if (!p->is_active) {

   440

			PlayerID i = p->index;

   441

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

   442

			p->index = i;

   443

			return p;

   444

		}

   445

	}

   446

	return NULL;

   447

}

   448

   449

void ResetPlayerLivery(Player *p)

   450

{

   451

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

   452

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

   453

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

   454

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

   455

	}

   456

}

   457

   458

Player *DoStartupNewPlayer(bool is_ai)

   459

{

   460

	Player *p;

   461

   462

	p = AllocatePlayer();

   463

	if (p == NULL) return NULL;

   464

   465

	/* Make a color */

   466

	p->player_color = GeneratePlayerColor();

   467

	ResetPlayerLivery(p);

   468

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

   469

	p->name_1 = STR_SV_UNNAMED;

   470

	p->is_active = true;

   471

   472

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

   473

   474

	p->is_ai = is_ai;

   475

	p->ai.state = 5; // AIS_WANT_NEW_ROUTE

   476

	p->share_owners[0] = p->share_owners[1] = p->share_owners[2] = p->share_owners[3] = PLAYER_SPECTATOR;

   477

   478

	p->avail_railtypes = GetPlayerRailtypes(p->index);

   479

	p->avail_roadtypes = GetPlayerRoadtypes(p->index);

   480

	p->inaugurated_year = _cur_year;

   481

	p->face = ConvertFromOldPlayerFace(Random());

   482

   483

	/* Engine renewal settings */

   484

	p->engine_renew_list = NULL;

   485

	p->renew_keep_length = false;

   486

	p->engine_renew = false;

   487

	p->engine_renew_months = -6;

   488

	p->engine_renew_money = 100000;

   489

   490

	GeneratePresidentName(p);

   491

   492

	InvalidateWindow(WC_GRAPH_LEGEND, 0);

   493

	InvalidateWindow(WC_TOOLBAR_MENU, 0);

   494

	InvalidateWindow(WC_CLIENT_LIST, 0);

   495