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

    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 = lips * 15 / 16;

   111

			lips -= 3;

   112

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

   113

		} else {

   114

			lips = ScalePlayerFaceValue(PFV_LIPS, ge, lips);

   115

		}

   116

		SetPlayerFaceBits(pf, PFV_LIPS, ge, lips);

   117

   118

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

   119

		if (ge == GE_WF) {

   120

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

   121

		} else {

   122

			nose = ScalePlayerFaceValue(PFV_NOSE, ge, nose);

   123

		}

   124

		SetPlayerFaceBits(pf, PFV_NOSE, ge, nose);

   125

	}

   126

   127

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

   128

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

   129

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

   130

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

   131

	}

   132

   133

	return pf;

   134

}

   135

   136

/**

   137

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

   138

 * Unused bits are not enforced to be 0.

   139

 * @param pf the fact to check

   140

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

   141

 */

   142

bool IsValidPlayerFace(PlayerFace pf)

   143

{

   144

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

   145

   146

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

   147

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

   148

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

   149

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

   150

   151

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

   152

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

   153

		switch (pfv) {

   154

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

   155

			case PFV_LIPS:        /* FALL THROUGH */

   156

			case PFV_NOSE:        if (has_moustache)    continue; break;

   157

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

   158

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

   159

			default: break;

   160

		}

   161

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

   162

	}

   163

   164

	return true;

   165

}

   166

   167

void InvalidatePlayerWindows(const Player *p)

   168

{

   169

	PlayerID pid = p->index;

   170

   171

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

   172

	InvalidateWindow(WC_FINANCES, pid);

   173

}

   174

   175

bool CheckPlayerHasMoney(int32 cost)

   176

{

   177

	if (cost > 0) {

   178

		PlayerID pid = _current_player;

   179

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

   180

			SetDParam(0, cost);

   181

			_error_message = STR_0003_NOT_ENOUGH_CASH_REQUIRES;

   182

			return false;

   183

		}

   184

	}

   185

	return true;

   186

}

   187

   188

static void SubtractMoneyFromAnyPlayer(Player *p, int32 cost)

   189

{

   190

	p->money64 -= cost;

   191

	UpdatePlayerMoney32(p);

   192

   193

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

   194

   195

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

   196

		p->cur_economy.income -= cost;

   197

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

   198

		p->cur_economy.expenses -= cost;

   199

	}

   200

   201

	InvalidatePlayerWindows(p);

   202

}

   203

   204

void SubtractMoneyFromPlayer(int32 cost)

   205

{

   206

	PlayerID pid = _current_player;

   207

   208

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

   209

}

   210

   211

void SubtractMoneyFromPlayerFract(PlayerID player, int32 cost)

   212

{

   213

	Player *p = GetPlayer(player);

   214

	byte m = p->player_money_fraction;

   215

   216

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

   217

	cost >>= 8;

   218

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

   219

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

   220

}

   221

   222

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

   223

void UpdatePlayerMoney32(Player *p)

   224

{

   225

	if (p->money64 < -2000000000) {

   226

		p->player_money = -2000000000;

   227

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

   228

		p->player_money = 2000000000;

   229

	} else {

   230

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

   231

	}

   232

}

   233

   234

void GetNameOfOwner(Owner owner, TileIndex tile)

   235

{

   236

	SetDParam(2, owner);

   237

   238

	if (owner != OWNER_TOWN) {

   239

		if (!IsValidPlayer(owner)) {

   240

			SetDParam(0, STR_0150_SOMEONE);

   241

		} else {

   242

			const Player* p = GetPlayer(owner);

   243

   244

			SetDParam(0, p->name_1);

   245

			SetDParam(1, p->name_2);

   246

		}

   247

	} else {

   248

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

   249

   250

		SetDParam(0, STR_TOWN);

   251

		SetDParam(1, t->index);

   252

	}

   253

}

   254

   255

   256

bool CheckOwnership(PlayerID owner)

   257

{

   258

	assert(owner < OWNER_END);

   259

   260

	if (owner == _current_player) return true;

   261

	_error_message = STR_013B_OWNED_BY;

   262

	GetNameOfOwner(owner, 0);

   263

	return false;

   264

}

   265

   266

bool CheckTileOwnership(TileIndex tile)

   267

{

   268

	Owner owner = GetTileOwner(tile);

   269

   270

	assert(owner < OWNER_END);

   271

   272

	if (owner == _current_player) return true;

   273

	_error_message = STR_013B_OWNED_BY;

   274

   275

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

   276

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

   277

	return false;

   278

}

   279

   280

static void GenerateCompanyName(Player *p)

   281

{

   282

	TileIndex tile;

   283

	Town *t;

   284

	StringID str;

   285

	Player *pp;

   286

	uint32 strp;

   287

	char buffer[100];

   288

   289

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

   290

   291

	tile = p->last_build_coordinate;

   292

	if (tile == 0) return;

   293

   294

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

   295

   296

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

   297

		str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_PLAYERNAME_START;

   298

		strp = t->townnameparts;

   299

   300

verify_name:;

   301

		/* No player must have this name already */

   302

		FOR_ALL_PLAYERS(pp) {

   303

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

   304

		}

   305

   306

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

   307

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

   308

			goto bad_town_name;

   309

   310

set_name:;

   311

		p->name_1 = str;

   312

		p->name_2 = strp;

   313

   314

		MarkWholeScreenDirty();

   315

   316

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

   317

			SetDParam(0, t->index);

   318

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

   319

		}

   320

		return;

   321

	}

   322

bad_town_name:;

   323

   324

	if (p->president_name_1 == SPECSTR_PRESIDENT_NAME) {

   325

		str = SPECSTR_ANDCO_NAME;

   326

		strp = p->president_name_2;

   327

		goto set_name;

   328

	} else {

   329

		str = SPECSTR_ANDCO_NAME;

   330

		strp = Random();

   331

		goto verify_name;

   332

	}

   333

}

   334

   335

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

   336

   337

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

   338

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

   339

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

   340

   341

static byte GeneratePlayerColor()

   342

{

   343

	byte colors[16], pcolor, t2;

   344

	int i,j,n;

   345

	uint32 r;

   346

	Player *p;

   347

   348

	/* Initialize array */

   349

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

   350

   351

	/* And randomize it */

   352

	n = 100;

   353

	do {

   354

		r = Random();

   355

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

   356

	} while (--n);

   357

   358

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

   359

	i = 16;

   360

	do {

   361

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

   362

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

   363

				COLOR_SWAP(j, j + 1);

   364

			}

   365

		}

   366

	} while (--i);

   367

   368

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

   369

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

   370

		pcolor = p->player_color;

   371

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

   372

			colors[i] = 0xFF;

   373

   374

			t2 = _color_similar_1[pcolor];

   375

			if (t2 == 0xFF) break;

   376

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

   377

				if (colors[i] == t2) {

   378

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

   379

					break;

   380

				}

   381

			}

   382

   383

			t2 = _color_similar_2[pcolor];

   384

			if (t2 == 0xFF) break;

   385

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

   386

				if (colors[i] == t2) {

   387

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

   388

					break;

   389

				}

   390

			}

   391

			break;

   392

		}

   393

	}

   394

   395

	/* Return the first available color */

   396

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

   397

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

   398

	}

   399

}

   400

   401

static void GeneratePresidentName(Player *p)

   402

{

   403

	Player *pp;

   404

	char buffer[100], buffer2[40];

   405

   406

	for (;;) {

   407

restart:;

   408

   409

		p->president_name_2 = Random();

   410

		p->president_name_1 = SPECSTR_PRESIDENT_NAME;

   411

   412

		SetDParam(0, p->president_name_2);

   413

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

   414

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

   415

			continue;

   416

   417

		FOR_ALL_PLAYERS(pp) {

   418

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

   419

				SetDParam(0, pp->president_name_2);

   420

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

   421

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

   422

					goto restart;

   423

			}

   424

		}

   425

		return;

   426

	}

   427

}

   428

   429

static Player *AllocatePlayer()

   430

{

   431

	Player *p;

   432

	/* Find a free slot */

   433

	FOR_ALL_PLAYERS(p) {

   434

		if (!p->is_active) {

   435

			PlayerID i = p->index;

   436

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

   437

			p->index = i;

   438

			return p;

   439

		}

   440

	}

   441

	return NULL;

   442

}

   443

   444

void ResetPlayerLivery(Player *p)

   445

{

   446

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

   447

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

   448

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

   449

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

   450

	}

   451

}

   452

   453

Player *DoStartupNewPlayer(bool is_ai)

   454

{

   455

	Player *p;

   456

   457

	p = AllocatePlayer();

   458

	if (p == NULL) return NULL;

   459

   460

	/* Make a color */

   461

	p->player_color = GeneratePlayerColor();

   462

	ResetPlayerLivery(p);

   463

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

   464

	p->name_1 = STR_SV_UNNAMED;

   465

	p->is_active = true;

   466

   467

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

   468

   469

	p->is_ai = is_ai;

   470

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

   471

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

   472

   473

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

   474

	p->inaugurated_year = _cur_year;

   475

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

   476

   477

	/* Engine renewal settings */

   478

	p->engine_renew_list = NULL;

   479

	p->renew_keep_length = false;

   480

	p->engine_renew = false;

   481

	p->engine_renew_months = -6;

   482

	p->engine_renew_money = 100000;

   483

   484

	GeneratePresidentName(p);

   485

   486

	InvalidateWindow(WC_GRAPH_LEGEND, 0);

   487

	InvalidateWindow(WC_TOOLBAR_MENU, 0);

   488

	InvalidateWindow(WC_CLIENT_LIST, 0);

   489

   490

	if (is_ai && (!_networking || _network_server) && _ai.enabled)

   491

		AI_StartNewAI(p->index);

   492

   493

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

   494

   495

	return p;

   496