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

#include "settings.h"

    32

    33

/**

    34

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

    35

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

    36

 * @param new_player the new player

    37

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

    38

 */

    39

void SetLocalPlayer(PlayerID new_player)

    40

{

    41

	/* Player could also be PLAYER_SPECTATOR or OWNER_NONE */

    42

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

    43

    44

	_local_player = new_player;

    45

    46

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

    47

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

    48

		const Player *p = GetPlayer(new_player);

    49

		_patches.autorenew        = p->engine_renew;

    50

		_patches.autorenew_months = p->engine_renew_months;

    51

		_patches.autorenew_money  = p->engine_renew_money;

    52

		InvalidateWindow(WC_GAME_OPTIONS, 0);

    53

	}

    54

}

    55

    56

    57

uint16 GetDrawStringPlayerColor(PlayerID player)

    58

{

    59

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

    60

	 * of the player */

    61

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

    62

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

    63

}

    64

    65

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

    66

{

    67

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

    68

}

    69

    70

/**

    71

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

    72

 *

    73

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

    74

 * - 4 and 5: chin

    75

 * - 6 to 9: eyebrows

    76

 * - 10 to 13: nose

    77

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

    78

 * - 16 to 19: hair

    79

 * - 20 to 22: eye color

    80

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

    81

 * - 28 to 30: glasses

    82

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

    83

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

    84

 *

    85

 * @param face the face in the old format

    86

 * @return the face in the new format

    87

 */

    88

PlayerFace ConvertFromOldPlayerFace(uint32 face)

    89

{

    90

	PlayerFace pf = 0;

    91

	GenderEthnicity ge = GE_WM;

    92

    93

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

    94

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

    95

    96

	SetPlayerFaceBits(pf, PFV_GEN_ETHN,    ge, ge);

    97

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

    98

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

    99

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

   100

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

   101

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

   102

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

   103

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

   104

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

   105

   106

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

   107

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

   108

		SetPlayerFaceBits(pf, PFV_HAS_MOUSTACHE, ge, true);

   109

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

   110

	} else {

   111

		if (!HasBit(ge, GENDER_FEMALE)) {

   112

			lips = lips * 15 / 16;

   113

			lips -= 3;

   114

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

   115

		} else {

   116

			lips = ScalePlayerFaceValue(PFV_LIPS, ge, lips);

   117

		}

   118

		SetPlayerFaceBits(pf, PFV_LIPS, ge, lips);

   119

   120

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

   121

		if (ge == GE_WF) {

   122

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

   123

		} else {

   124

			nose = ScalePlayerFaceValue(PFV_NOSE, ge, nose);

   125

		}

   126

		SetPlayerFaceBits(pf, PFV_NOSE, ge, nose);

   127

	}

   128

   129

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

   130

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

   131

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

   132

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

   133

	}

   134

   135

	return pf;

   136

}

   137

   138

/**

   139

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

   140

 * Unused bits are not enforced to be 0.

   141

 * @param pf the fact to check

   142

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

   143

 */

   144

bool IsValidPlayerFace(PlayerFace pf)

   145

{

   146

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

   147

   148

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

   149

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

   150

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

   151

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

   152

   153

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

   154

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

   155

		switch (pfv) {

   156

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

   157

			case PFV_LIPS:        /* FALL THROUGH */

   158

			case PFV_NOSE:        if (has_moustache)    continue; break;

   159

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

   160

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

   161

			default: break;

   162

		}

   163

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

   164

	}

   165

   166

	return true;

   167

}

   168

   169

void InvalidatePlayerWindows(const Player *p)

   170

{

   171

	PlayerID pid = p->index;

   172

   173

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

   174

	InvalidateWindow(WC_FINANCES, pid);

   175

}

   176

   177

bool CheckPlayerHasMoney(CommandCost cost)

   178

{

   179

	if (cost.GetCost() > 0) {

   180

		PlayerID pid = _current_player;

   181

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

   182

			SetDParam(0, cost.GetCost());

   183

			_error_message = STR_0003_NOT_ENOUGH_CASH_REQUIRES;

   184

			return false;

   185

		}

   186

	}

   187

	return true;

   188

}

   189

   190

static void SubtractMoneyFromAnyPlayer(Player *p, CommandCost cost)

   191

{

   192

	CommandCost tmp(p->player_money);

   193

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

   194

	p->player_money = tmp.GetCost();

   195

   196

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

   197

	tmp.AddCost(cost);

   198

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

   199

   200

	if (HasBit(1 << EXPENSES_TRAIN_INC    |

   201

	           1 << EXPENSES_ROADVEH_INC  |

   202

	           1 << EXPENSES_AIRCRAFT_INC |

   203

	           1 << EXPENSES_SHIP_INC, _yearly_expenses_type)) {

   204

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

   205

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

   206

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

   207

	} else if (HasBit(1 << EXPENSES_TRAIN_RUN    |

   208

	                  1 << EXPENSES_ROADVEH_RUN  |

   209

	                  1 << EXPENSES_AIRCRAFT_RUN |

   210

	                  1 << EXPENSES_SHIP_RUN     |

   211

	                  1 << EXPENSES_PROPERTY     |

   212

	                  1 << EXPENSES_LOAN_INT, _yearly_expenses_type)) {

   213

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

   214

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

   215

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

   216

	}

   217

   218

	InvalidatePlayerWindows(p);

   219

}

   220

   221

void SubtractMoneyFromPlayer(CommandCost cost)

   222

{

   223

	PlayerID pid = _current_player;

   224

   225

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

   226

}

   227

   228

void SubtractMoneyFromPlayerFract(PlayerID player, CommandCost cst)

   229

{

   230

	Player *p = GetPlayer(player);

   231

	byte m = p->player_money_fraction;

   232

	Money cost = cst.GetCost();

   233

   234

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

   235

	cost >>= 8;

   236

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

   237

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

   238

}

   239

   240

void GetNameOfOwner(Owner owner, TileIndex tile)

   241

{

   242

	SetDParam(2, owner);

   243

   244

	if (owner != OWNER_TOWN) {

   245

		if (!IsValidPlayer(owner)) {

   246

			SetDParam(0, STR_0150_SOMEONE);

   247

		} else {

   248

			const Player* p = GetPlayer(owner);

   249

   250

			SetDParam(0, STR_COMPANY_NAME);

   251

			SetDParam(1, p->index);

   252

		}

   253

	} else {

   254

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

   255

   256

		SetDParam(0, STR_TOWN);

   257

		SetDParam(1, t->index);

   258

	}

   259

}

   260

   261

   262

bool CheckOwnership(PlayerID owner)

   263

{

   264

	assert(owner < OWNER_END);

   265

   266

	if (owner == _current_player) return true;

   267

	_error_message = STR_013B_OWNED_BY;

   268

	GetNameOfOwner(owner, 0);

   269

	return false;

   270

}

   271

   272

bool CheckTileOwnership(TileIndex tile)

   273

{

   274

	Owner owner = GetTileOwner(tile);

   275

   276

	assert(owner < OWNER_END);

   277

   278

	if (owner == _current_player) return true;

   279

	_error_message = STR_013B_OWNED_BY;

   280

   281

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

   282

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

   283

	return false;

   284

}

   285

   286

static void GenerateCompanyName(Player *p)

   287

{

   288

	TileIndex tile;

   289

	Town *t;

   290

	StringID str;

   291

	Player *pp;

   292

	uint32 strp;

   293

	char buffer[100];

   294

   295

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

   296

   297

	tile = p->last_build_coordinate;

   298

	if (tile == 0) return;

   299

   300

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

   301

   302

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

   303

		str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_PLAYERNAME_START;

   304

		strp = t->townnameparts;

   305

   306

verify_name:;

   307

		/* No player must have this name already */

   308

		FOR_ALL_PLAYERS(pp) {

   309

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

   310

		}

   311

   312

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

   313

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

   314

			goto bad_town_name;

   315

   316

set_name:;

   317

		p->name_1 = str;

   318

		p->name_2 = strp;

   319

   320

		MarkWholeScreenDirty();

   321

   322

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

   323

			SetDParam(0, t->index);

   324

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

   325

		}

   326

		return;

   327

	}

   328

bad_town_name:;

   329

   330

	if (p->president_name_1 == SPECSTR_PRESIDENT_NAME) {

   331

		str = SPECSTR_ANDCO_NAME;

   332

		strp = p->president_name_2;

   333

		goto set_name;

   334

	} else {

   335

		str = SPECSTR_ANDCO_NAME;

   336

		strp = Random();

   337

		goto verify_name;

   338

	}

   339

}

   340

   341

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

   342

   343

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

   344

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

   345

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

   346

   347

static byte GeneratePlayerColor()

   348

{

   349

	byte colors[16], pcolor, t2;

   350

	int i,j,n;

   351

	uint32 r;

   352

	Player *p;

   353

   354

	/* Initialize array */

   355

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

   356

   357

	/* And randomize it */

   358

	n = 100;

   359

	do {

   360

		r = Random();

   361

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

   362

	} while (--n);

   363

   364

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

   365

	i = 16;

   366

	do {

   367

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

   368

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

   369

				COLOR_SWAP(j, j + 1);

   370

			}

   371

		}

   372

	} while (--i);

   373

   374

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

   375

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

   376

		pcolor = p->player_color;

   377

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

   378

			colors[i] = 0xFF;

   379

   380

			t2 = _color_similar_1[pcolor];

   381

			if (t2 == 0xFF) break;

   382

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

   383

				if (colors[i] == t2) {

   384

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

   385

					break;

   386

				}

   387

			}

   388

   389

			t2 = _color_similar_2[pcolor];

   390

			if (t2 == 0xFF) break;

   391

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

   392

				if (colors[i] == t2) {

   393

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

   394

					break;

   395

				}

   396

			}

   397

			break;

   398

		}

   399

	}

   400

   401

	/* Return the first available color */

   402

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

   403

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

   404

	}

   405

}

   406

   407

static void GeneratePresidentName(Player *p)

   408

{

   409

	Player *pp;

   410

	char buffer[100], buffer2[40];

   411

   412

	for (;;) {

   413

restart:;

   414

   415

		p->president_name_2 = Random();

   416

		p->president_name_1 = SPECSTR_PRESIDENT_NAME;

   417

   418

		SetDParam(0, p->index);

   419

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

   420

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

   421

			continue;

   422

   423

		FOR_ALL_PLAYERS(pp) {

   424

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

   425

				SetDParam(0, pp->index);

   426

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

   427

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

   428

					goto restart;

   429

			}

   430

		}

   431

		return;

   432

	}

   433

}

   434

   435

static Player *AllocatePlayer()

   436

{

   437

	Player *p;

   438

	/* Find a free slot */

   439

	FOR_ALL_PLAYERS(p) {

   440

		if (!p->is_active) {

   441

			PlayerID i = p->index;

   442

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

   443

			p->index = i;

   444

			return p;

   445

		}

   446

	}

   447

	return NULL;

   448

}

   449

   450

void ResetPlayerLivery(Player *p)

   451

{

   452

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

   453

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

   454

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

   455

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

   456

	}

   457

}

   458

   459

/**

   460

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

   461

 *

   462

 * @param is_ai is a ai player?

   463

 * @return the player struct

   464

 */

   465

Player *DoStartupNewPlayer(bool is_ai)

   466

{

   467

	Player *p;

   468

   469

	p = AllocatePlayer();

   470

	if (p == NULL) return NULL;

   471

   472

	/* Make a color */

   473

	p->player_color = GeneratePlayerColor();

   474

	ResetPlayerLivery(p);

   475

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

   476

	p->name_1 = STR_SV_UNNAMED;

   477

	p->is_active = true;

   478

   479

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

   480

   481

	p->is_ai = is_ai;

   482

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

   483

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

   484

   485

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

   486

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

   487

	p->inaugurated_year = _cur_year;

   488

	RandomPlayerFaceBits(p->face, (GenderEthnicity)Random(), false); // create a random player face

   489

   490

	/* Engine renewal settings */

   491

	p->engine_renew_list = NULL;

   492

	p->renew_keep_length = false;

   493

	p->engine_renew = _patches_newgame.autorenew;

   494

	p->engine_renew_months = _patches_newgame.autorenew_months;