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 "table/strings.h"

    11

#include "table/sprites.h"

    12

#include "map.h"

    13

#include "player.h"

    14

#include "town.h"

    15

#include "vehicle.h"

    16

#include "station.h"

    17

#include "news.h"

    18

#include "saveload.h"

    19

#include "command_func.h"

    20

#include "sound.h"

    21

#include "network/network.h"

    22

#include "variables.h"

    23

#include "engine.h"

    24

#include "ai/ai.h"

    25

#include "date.h"

    26

#include "player_face.h"

    27

#include "group.h"

    28

#include "settings.h"

    29

#include "window_func.h"

    30

#include "tile_map.h"

    31

#include "strings_func.h"

    33

    34

/**

    35

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

    36

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

    37

 * @param new_player the new player

    38

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

    39

 */

    40

void SetLocalPlayer(PlayerID new_player)

    41

{

    42

	/* Player could also be PLAYER_SPECTATOR or OWNER_NONE */

    43

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

    44

    45

	_local_player = new_player;

    46

    47

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

    48

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

    49

		const Player *p = GetPlayer(new_player);

    50

		_patches.autorenew        = p->engine_renew;

    51

		_patches.autorenew_months = p->engine_renew_months;

    52

		_patches.autorenew_money  = p->engine_renew_money;

    53

		InvalidateWindow(WC_GAME_OPTIONS, 0);

    54

	}

    55

}

    56

    57

    58

uint16 GetDrawStringPlayerColor(PlayerID player)

    59

{

    60

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

    61

	 * of the player */

    62

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

    63

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

    64

}

    65

    66

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

    67

{

    68

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

    69

}

    70

    71

/**

    72

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

    73

 *

    74

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

    75

 * - 4 and 5: chin

    76

 * - 6 to 9: eyebrows

    77

 * - 10 to 13: nose

    78

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

    79

 * - 16 to 19: hair

    80

 * - 20 to 22: eye color

    81

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

    82

 * - 28 to 30: glasses

    83

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

    84

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

    85

 *

    86

 * @param face the face in the old format

    87

 * @return the face in the new format

    88

 */

    89

PlayerFace ConvertFromOldPlayerFace(uint32 face)

    90

{

    91

	PlayerFace pf = 0;

    92

	GenderEthnicity ge = GE_WM;

    93

    94

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

    95

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

    96

    97

	SetPlayerFaceBits(pf, PFV_GEN_ETHN,    ge, ge);

    98

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

    99

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

   100

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

   101

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

   102

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

   103

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

   104

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

   105

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

   106

   107

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

   108

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

   109

		SetPlayerFaceBits(pf, PFV_HAS_MOUSTACHE, ge, true);

   110

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

   111

	} else {

   112

		if (!HasBit(ge, GENDER_FEMALE)) {

   113

			lips = lips * 15 / 16;

   114

			lips -= 3;

   115

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

   116

		} else {

   117

			lips = ScalePlayerFaceValue(PFV_LIPS, ge, lips);

   118

		}

   119

		SetPlayerFaceBits(pf, PFV_LIPS, ge, lips);

   120

   121

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

   122

		if (ge == GE_WF) {

   123

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

   124

		} else {

   125

			nose = ScalePlayerFaceValue(PFV_NOSE, ge, nose);

   126

		}

   127

		SetPlayerFaceBits(pf, PFV_NOSE, ge, nose);

   128

	}

   129

   130

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

   131

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

   132

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

   133

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

   134

	}

   135

   136

	return pf;

   137

}

   138

   139

/**

   140

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

   141

 * Unused bits are not enforced to be 0.

   142

 * @param pf the fact to check

   143

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

   144

 */

   145

bool IsValidPlayerFace(PlayerFace pf)

   146

{

   147

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

   148

   149

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

   150

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

   151

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

   152

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

   153

   154

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

   155

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

   156

		switch (pfv) {

   157

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

   158

			case PFV_LIPS:        /* FALL THROUGH */

   159

			case PFV_NOSE:        if (has_moustache)    continue; break;

   160

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

   161

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

   162

			default: break;

   163

		}

   164

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

   165

	}

   166

   167

	return true;

   168

}

   169

   170

void InvalidatePlayerWindows(const Player *p)

   171

{

   172

	PlayerID pid = p->index;

   173

   174

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

   175

	InvalidateWindow(WC_FINANCES, pid);

   176

}

   177

   178

bool CheckPlayerHasMoney(CommandCost cost)

   179

{

   180

	if (cost.GetCost() > 0) {

   181

		PlayerID pid = _current_player;

   182

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

   183

			SetDParam(0, cost.GetCost());

   184

			_error_message = STR_0003_NOT_ENOUGH_CASH_REQUIRES;

   185

			return false;

   186

		}

   187

	}

   188

	return true;

   189

}

   190

   191

static void SubtractMoneyFromAnyPlayer(Player *p, CommandCost cost)

   192

{

   193

	CommandCost tmp(p->player_money);

   194

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

   195

	p->player_money = tmp.GetCost();

   196

   197

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

   198

	tmp.AddCost(cost);

   199

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

   200

   201

	if (HasBit(1 << EXPENSES_TRAIN_INC    |

   202

	           1 << EXPENSES_ROADVEH_INC  |

   203

	           1 << EXPENSES_AIRCRAFT_INC |

   204

	           1 << EXPENSES_SHIP_INC, _yearly_expenses_type)) {

   205

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

   206

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

   207

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

   208

	} else if (HasBit(1 << EXPENSES_TRAIN_RUN    |

   209

	                  1 << EXPENSES_ROADVEH_RUN  |

   210

	                  1 << EXPENSES_AIRCRAFT_RUN |

   211

	                  1 << EXPENSES_SHIP_RUN     |

   212

	                  1 << EXPENSES_PROPERTY     |

   213

	                  1 << EXPENSES_LOAN_INT, _yearly_expenses_type)) {

   214

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

   215

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

   216

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

   217

	}

   218

   219

	InvalidatePlayerWindows(p);

   220

}

   221

   222

void SubtractMoneyFromPlayer(CommandCost cost)

   223

{

   224

	PlayerID pid = _current_player;

   225

   226

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

   227

}

   228

   229

void SubtractMoneyFromPlayerFract(PlayerID player, CommandCost cst)

   230

{

   231

	Player *p = GetPlayer(player);

   232

	byte m = p->player_money_fraction;

   233

	Money cost = cst.GetCost();

   234

   235

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

   236

	cost >>= 8;

   237

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

   238

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

   239

}

   240

   241

void GetNameOfOwner(Owner owner, TileIndex tile)

   242

{

   243

	SetDParam(2, owner);

   244

   245

	if (owner != OWNER_TOWN) {

   246

		if (!IsValidPlayer(owner)) {

   247

			SetDParam(0, STR_0150_SOMEONE);

   248

		} else {

   249

			const Player* p = GetPlayer(owner);

   250

   251

			SetDParam(0, STR_COMPANY_NAME);

   252

			SetDParam(1, p->index);

   253

		}

   254

	} else {

   255

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

   256

   257

		SetDParam(0, STR_TOWN);

   258

		SetDParam(1, t->index);

   259

	}

   260

}

   261

   262

   263

bool CheckOwnership(PlayerID owner)

   264

{

   265

	assert(owner < OWNER_END);

   266

   267

	if (owner == _current_player) return true;

   268

	_error_message = STR_013B_OWNED_BY;

   269

	GetNameOfOwner(owner, 0);

   270

	return false;

   271

}

   272

   273

bool CheckTileOwnership(TileIndex tile)

   274

{

   275

	Owner owner = GetTileOwner(tile);

   276

   277

	assert(owner < OWNER_END);

   278

   279

	if (owner == _current_player) return true;

   280

	_error_message = STR_013B_OWNED_BY;

   281

   282

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

   283

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

   284

	return false;

   285

}

   286

   287

static void GenerateCompanyName(Player *p)

   288

{

   289

	TileIndex tile;

   290

	Town *t;

   291

	StringID str;

   292

	Player *pp;

   293

	uint32 strp;

   294

	char buffer[100];

   295

   296

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

   297

   298

	tile = p->last_build_coordinate;

   299

	if (tile == 0) return;

   300

   301

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

   302

   303

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

   304

		str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_PLAYERNAME_START;

   305

		strp = t->townnameparts;

   306

   307

verify_name:;

   308

		/* No player must have this name already */

   309

		FOR_ALL_PLAYERS(pp) {

   310

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

   311

		}

   312

   313

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

   314

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

   315

			goto bad_town_name;

   316

   317

set_name:;

   318

		p->name_1 = str;

   319

		p->name_2 = strp;

   320

   321

		MarkWholeScreenDirty();

   322

   323

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

   324

			SetDParam(0, t->index);

   325

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

   326

		}

   327

		return;

   328

	}

   329

bad_town_name:;

   330

   331

	if (p->president_name_1 == SPECSTR_PRESIDENT_NAME) {

   332

		str = SPECSTR_ANDCO_NAME;

   333

		strp = p->president_name_2;

   334

		goto set_name;

   335

	} else {

   336

		str = SPECSTR_ANDCO_NAME;

   337

		strp = Random();

   338

		goto verify_name;

   339

	}

   340

}

   341

   342

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

   343

   344

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

   345

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

   346

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

   347

   348

static byte GeneratePlayerColor()

   349

{

   350

	byte colors[16], pcolor, t2;

   351

	int i,j,n;

   352

	uint32 r;

   353

	Player *p;

   354

   355

	/* Initialize array */

   356

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

   357

   358

	/* And randomize it */

   359

	n = 100;

   360

	do {

   361

		r = Random();

   362

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

   363

	} while (--n);

   364

   365

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

   366

	i = 16;

   367

	do {

   368

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

   369

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

   370

				COLOR_SWAP(j, j + 1);

   371

			}

   372

		}

   373

	} while (--i);

   374

   375

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

   376

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

   377

		pcolor = p->player_color;

   378

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

   379

			colors[i] = 0xFF;

   380

   381

			t2 = _color_similar_1[pcolor];

   382

			if (t2 == 0xFF) break;

   383

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

   384

				if (colors[i] == t2) {

   385

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

   386

					break;

   387

				}

   388

			}

   389

   390

			t2 = _color_similar_2[pcolor];

   391

			if (t2 == 0xFF) break;

   392

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

   393

				if (colors[i] == t2) {

   394

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

   395

					break;

   396

				}

   397

			}

   398

			break;

   399

		}

   400

	}

   401

   402

	/* Return the first available color */

   403

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

   404

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

   405

	}

   406

}

   407

   408

static void GeneratePresidentName(Player *p)

   409

{

   410

	Player *pp;

   411

	char buffer[100], buffer2[40];

   412

   413

	for (;;) {

   414

restart:;

   415

   416

		p->president_name_2 = Random();

   417

		p->president_name_1 = SPECSTR_PRESIDENT_NAME;

   418

   419

		SetDParam(0, p->index);

   420

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

   421

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

   422

			continue;

   423

   424

		FOR_ALL_PLAYERS(pp) {

   425

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

   426

				SetDParam(0, pp->index);

   427

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

   428

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

   429

					goto restart;

   430

			}

   431

		}

   432

		return;

   433

	}

   434

}

   435

   436

static Player *AllocatePlayer()

   437

{

   438

	Player *p;

   439

	/* Find a free slot */

   440

	FOR_ALL_PLAYERS(p) {

   441

		if (!p->is_active) {

   442

			PlayerID i = p->index;

   443

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

   444

			p->index = i;

   445

			return p;

   446

		}

   447

	}

   448

	return NULL;

   449

}

   450

   451

void ResetPlayerLivery(Player *p)

   452

{

   453

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

   454

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

   455

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

   456

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

   457

	}

   458

}

   459

   460

/**

   461

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

   462

 *

   463

 * @param is_ai is a ai player?

   464

 * @return the player struct

   465

 */

   466

Player *DoStartupNewPlayer(bool is_ai)

   467

{

   468

	Player *p;

   469

   470

	p = AllocatePlayer();

   471

	if (p == NULL) return NULL;

   472

   473

	/* Make a color */

   474

	p->player_color = GeneratePlayerColor();

   475

	ResetPlayerLivery(p);

   476

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

   477

	p->name_1 = STR_SV_UNNAMED;

   478

	p->is_active = true;

   479

   480

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

   481

   482

	p->is_ai = is_ai;

   483

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

   484

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

   485

   486

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

   487

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

   488

	p->inaugurated_year = _cur_year;

   489

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

   490

   491

	/* Engine renewal settings */

   492

	p->engine_renew_list = NULL;

   493

	p->renew_keep_length = false;