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"

    27

#include "date.h"

    28

#include "window.h"

    29

#include "player_face.h"

    30

    31

/**

    32

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

    33

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

    34

 * @param new_player the new player

    35

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

    36

 */

    37

void SetLocalPlayer(PlayerID new_player)

    38

{

    39

	/* Player could also be PLAYER_SPECTATOR or OWNER_NONE */

    40

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

    41

    42

	_local_player = new_player;

    43

    44

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

    45

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

    46

		const Player *p = GetPlayer(new_player);

    47

		_patches.autorenew        = p->engine_renew;

    48

		_patches.autorenew_months = p->engine_renew_months;

    49

		_patches.autorenew_money  = p->engine_renew_money;

    50

		InvalidateWindow(WC_GAME_OPTIONS, 0);

    51

	}

    52

}

    53

    54

    55

uint16 GetDrawStringPlayerColor(PlayerID player)

    56

{

    57

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

    58

	 * of the player */

    59

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

    60

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

    61

}

    62

    63

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

    64

{

    65

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

    66

}

    67

    68

/**

    69

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

    70

 *

    71

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

    72

 * - 4 and 5: chin

    73

 * - 6 to 9: eyebrows

    74

 * - 10 to 13: nose

    75

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

    76

 * - 16 to 19: hair

    77

 * - 20 to 22: eye color

    78

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

    79

 * - 28 to 30: glasses

    80

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

    81

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

    82

 *

    83

 * @param face the face in the old format

    84

 * @return the face in the new format

    85

 */

    86

PlayerFace ConvertFromOldPlayerFace(uint32 face)

    87

{

    88

	PlayerFace pf = 0;

    89

	GenderEthnicity ge = GE_WM;

    90

    91

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

    92

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

    93

    94

	SetPlayerFaceBits(pf, PFV_GEN_ETHN,    ge, ge);

    95

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

    96

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

    97

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

    98

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

    99

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

   100

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

   101

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

   102

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

   103

   104

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

   105

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

   106

		SetPlayerFaceBits(pf, PFV_HAS_MOUSTACHE, ge, true);

   107

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

   108

	} else {

   109

		if (!HASBIT(ge, GENDER_FEMALE)) {

   110

			lips -= 3;

   111

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

   112

		} else {

   113

			lips = ScalePlayerFaceValue(PFV_LIPS, ge, lips);

   114

		}

   115

		SetPlayerFaceBits(pf, PFV_LIPS, ge, lips);

   116

   117

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

   118

		if (ge == GE_WF) {

   119

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

   120

		} else {

   121

			nose = ScalePlayerFaceValue(PFV_NOSE, ge, nose);

   122

		}

   123

		SetPlayerFaceBits(pf, PFV_NOSE, ge, nose);

   124

	}

   125

   126

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

   127

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

   128

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

   129

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

   130

	}

   131

   132

	return pf;

   133

}

   134

   135

/**

   136

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

   137

 * Unused bits are not enforced to be 0.

   138

 * @param pf the fact to check

   139

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

   140

 */

   141

bool IsValidPlayerFace(PlayerFace pf)

   142

{

   143

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

   144

   145

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

   146

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

   147

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

   148

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

   149

   150

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

   151

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

   152

		switch (pfv) {

   153

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

   154

			case PFV_LIPS:        /* FALL THROUGH */

   155

			case PFV_NOSE:        if (has_moustache)    continue; break;

   156

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

   157

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

   158

			default: break;

   159

		}

   160

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

   161

	}

   162

   163

	return true;

   164

}

   165

   166

void InvalidatePlayerWindows(const Player *p)

   167

{

   168

	PlayerID pid = p->index;

   169

   170

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

   171

	InvalidateWindow(WC_FINANCES, pid);

   172

}

   173

   174

bool CheckPlayerHasMoney(int32 cost)

   175

{

   176

	if (cost > 0) {

   177

		PlayerID pid = _current_player;

   178

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

   179

			SetDParam(0, cost);

   180

			_error_message = STR_0003_NOT_ENOUGH_CASH_REQUIRES;

   181

			return false;

   182

		}

   183

	}

   184

	return true;

   185

}

   186

   187

static void SubtractMoneyFromAnyPlayer(Player *p, int32 cost)

   188

{

   189

	p->money64 -= cost;

   190

	UpdatePlayerMoney32(p);

   191

   192

	p->yearly_expenses[0][_yearly_expenses_type] += cost;

   193

   194

	if (HASBIT(1<<7|1<<8|1<<9|1<<10, _yearly_expenses_type)) {

   195

		p->cur_economy.income -= cost;

   196

	} else if (HASBIT(1<<2|1<<3|1<<4|1<<5|1<<6|1<<11, _yearly_expenses_type)) {

   197

		p->cur_economy.expenses -= cost;

   198

	}

   199

   200

	InvalidatePlayerWindows(p);

   201

}

   202

   203

void SubtractMoneyFromPlayer(int32 cost)

   204

{

   205

	PlayerID pid = _current_player;

   206

   207

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

   208

}

   209

   210

void SubtractMoneyFromPlayerFract(PlayerID player, int32 cost)

   211

{

   212

	Player *p = GetPlayer(player);

   213

	byte m = p->player_money_fraction;

   214

   215

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

   216

	cost >>= 8;

   217

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

   218

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

   219

}

   220

   221

// the player_money field is kept as it is, but money64 contains the actual amount of money.

   222

void UpdatePlayerMoney32(Player *p)

   223

{

   224

	if (p->money64 < -2000000000) {

   225

		p->player_money = -2000000000;

   226

	} else if (p->money64 > 2000000000) {

   227

		p->player_money = 2000000000;

   228

	} else {

   229

		p->player_money = (int32)p->money64;

   230

	}

   231

}

   232

   233

void GetNameOfOwner(Owner owner, TileIndex tile)

   234

{

   235

	SetDParam(2, owner);

   236

   237

	if (owner != OWNER_TOWN) {

   238

		if (!IsValidPlayer(owner)) {

   239

			SetDParam(0, STR_0150_SOMEONE);

   240

		} else {

   241

			const Player* p = GetPlayer(owner);

   242

   243

			SetDParam(0, p->name_1);

   244

			SetDParam(1, p->name_2);

   245

		}

   246

	} else {

   247

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

   248

   249

		SetDParam(0, STR_TOWN);

   250

		SetDParam(1, t->index);

   251

	}

   252

}

   253

   254

   255

bool CheckOwnership(PlayerID owner)

   256

{

   257

	assert(owner < OWNER_END);

   258

   259

	if (owner == _current_player) return true;

   260

	_error_message = STR_013B_OWNED_BY;

   261

	GetNameOfOwner(owner, 0);

   262

	return false;

   263

}

   264

   265

bool CheckTileOwnership(TileIndex tile)

   266

{

   267

	Owner owner = GetTileOwner(tile);

   268

   269

	assert(owner < OWNER_END);

   270

   271

	if (owner == _current_player) return true;

   272

	_error_message = STR_013B_OWNED_BY;

   273

   274

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

   275

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

   276

	return false;

   277

}

   278

   279

static void GenerateCompanyName(Player *p)

   280

{

   281

	TileIndex tile;

   282

	Town *t;

   283

	StringID str;

   284

	Player *pp;

   285

	uint32 strp;

   286

	char buffer[100];

   287

   288

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

   289

   290

	tile = p->last_build_coordinate;

   291

	if (tile == 0) return;

   292

   293

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

   294

   295

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

   296

		str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_PLAYERNAME_START;

   297

		strp = t->townnameparts;

   298

   299

verify_name:;

   300

		// No player must have this name already

   301

		FOR_ALL_PLAYERS(pp) {

   302

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

   303

		}

   304

   305

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

   306

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

   307

			goto bad_town_name;

   308

   309

set_name:;

   310

		p->name_1 = str;

   311

		p->name_2 = strp;

   312

   313

		MarkWholeScreenDirty();

   314

   315

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

   316

			SetDParam(0, t->index);

   317

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

   318

		}

   319

		return;

   320

	}

   321

bad_town_name:;

   322

   323

	if (p->president_name_1 == SPECSTR_PRESIDENT_NAME) {

   324

		str = SPECSTR_ANDCO_NAME;

   325

		strp = p->president_name_2;

   326

		goto set_name;

   327

	} else {

   328

		str = SPECSTR_ANDCO_NAME;

   329

		strp = Random();

   330

		goto verify_name;

   331

	}

   332

}

   333

   334

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

   335

   336

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

   337

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

   338

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

   339

   340

static byte GeneratePlayerColor()

   341

{

   342

	byte colors[16], pcolor, t2;

   343

	int i,j,n;

   344

	uint32 r;

   345

	Player *p;

   346

   347

	// Initialize array

   348

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

   349

   350

	// And randomize it

   351

	n = 100;

   352

	do {

   353

		r = Random();

   354

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

   355

	} while (--n);

   356

   357

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

   358

	i = 16;

   359

	do {

   360

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

   361

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

   362

				COLOR_SWAP(j, j + 1);

   363

			}

   364

		}

   365

	} while (--i);

   366

   367

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

   368

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

   369

		pcolor = p->player_color;

   370

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

   371

			colors[i] = 0xFF;

   372

   373

			t2 = _color_similar_1[pcolor];

   374

			if (t2 == 0xFF) break;

   375

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

   376

				if (colors[i] == t2) {

   377

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

   378

					break;

   379

				}

   380

			}

   381

   382

			t2 = _color_similar_2[pcolor];

   383

			if (t2 == 0xFF) break;

   384

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

   385

				if (colors[i] == t2) {

   386

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

   387

					break;

   388

				}

   389

			}

   390

			break;

   391

		}

   392

	}

   393

   394

	// Return the first available color

   395

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

   396

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

   397

	}

   398

}

   399

   400

static void GeneratePresidentName(Player *p)

   401

{

   402

	Player *pp;

   403

	char buffer[100], buffer2[40];

   404

   405

	for (;;) {

   406

restart:;

   407

   408

		p->president_name_2 = Random();

   409

		p->president_name_1 = SPECSTR_PRESIDENT_NAME;

   410

   411

		SetDParam(0, p->president_name_2);

   412

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

   413

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

   414

			continue;

   415

   416

		FOR_ALL_PLAYERS(pp) {

   417

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

   418

				SetDParam(0, pp->president_name_2);

   419

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

   420

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

   421

					goto restart;

   422

			}

   423

		}

   424

		return;

   425

	}

   426

}

   427

   428

static Player *AllocatePlayer()

   429

{

   430

	Player *p;

   431

	// Find a free slot

   432

	FOR_ALL_PLAYERS(p) {

   433

		if (!p->is_active) {

   434

			PlayerID i = p->index;

   435

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

   436

			p->index = i;

   437

			return p;

   438

		}

   439

	}

   440

	return NULL;

   441

}

   442

   443

void ResetPlayerLivery(Player *p)

   444

{

   445

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

   446

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

   447

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

   448

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

   449

	}

   450

}

   451

   452

Player *DoStartupNewPlayer(bool is_ai)

   453

{

   454

	Player *p;

   455

   456

	p = AllocatePlayer();

   457

	if (p == NULL) return NULL;

   458

   459

	// Make a color

   460

	p->player_color = GeneratePlayerColor();

   461

	ResetPlayerLivery(p);

   462

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

   463

	p->name_1 = STR_SV_UNNAMED;

   464

	p->is_active = true;

   465

   466

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

   467

   468

	p->is_ai = is_ai;

   469

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

   470

   471

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

   472

	p->inaugurated_year = _cur_year;

   473

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

   474

   475

	/* Engine renewal settings */

   476

	p->engine_renew_list = NULL;

   477

	p->renew_keep_length = false;

   478

	p->engine_renew = false;

   479

	p->engine_renew_months = -6;

   480

	p->engine_renew_money = 100000;

   481

   482

	GeneratePresidentName(p);

   483

   484

	InvalidateWindow(WC_GRAPH_LEGEND, 0);

   485

	InvalidateWindow(WC_TOOLBAR_MENU, 0);

   486

	InvalidateWindow(WC_CLIENT_LIST, 0);

   487

   489

   490

	memset(p->num_engines, 0, sizeof(p->num_engines));

   491

   492

	return p;

   493

}

   494

   495

void StartupPlayers()

   496

{

   497

	// The AI starts like in the setting with +2 month max