1

/* $Id$ */

     2

     3

/** @file players.cpp

     4

 */

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "engine.h"

     8

#include "table/strings.h"

     9

#include "table/sprites.h"

    10

#include "player.h"

    11

#include "town.h"

    12

#include "station.h"

    13

#include "news.h"

    14

#include "saveload.h"

    15

#include "command_func.h"

    16

#include "network/network.h"

    17

#include "variables.h"

    18

#include "engine.h"

    19

#include "ai/ai.h"

    20

#include "player_face.h"

    21

#include "group.h"

    22

#include "window_func.h"

    23

#include "tile_map.h"

    24

#include "strings_func.h"

    25

#include "gfx_func.h"

    26

#include "functions.h"

    27

#include "date_func.h"

    28

#include "vehicle_func.h"

    29

#include "sound_func.h"

    30

#include "autoreplace_func.h"

    31

#include "autoreplace_gui.h"

    32

#include "string_func.h"

    33

#include "ai/default/default.h"

    34

#include "ai/trolly/trolly.h"

    35

    36

/**

    37

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

    38

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

    39

 * @param new_player the new player

    40

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

    41

 */

    42

void SetLocalPlayer(PlayerID new_player)

    43

{

    44

	/* Player could also be PLAYER_SPECTATOR or OWNER_NONE */

    45

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

    46

    47

	_local_player = new_player;

    48

    49

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

    50

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

    51

		const Player *p = GetPlayer(new_player);

    52

		_patches.autorenew        = p->engine_renew;

    53

		_patches.autorenew_months = p->engine_renew_months;

    54

		_patches.autorenew_money  = p->engine_renew_money;

    55

		InvalidateWindow(WC_GAME_OPTIONS, 0);

    56

	}

    57

}

    58

    59

    60

uint16 GetDrawStringPlayerColor(PlayerID player)

    61

{

    62

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

    63

	 * of the player */

    64

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

    65

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

    66

}

    67

    68

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

    69

{

    70

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

    71

}

    72

    73

/**

    74

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

    75

 *

    76

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

    77

 * - 4 and 5: chin

    78

 * - 6 to 9: eyebrows

    79

 * - 10 to 13: nose

    80

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

    81

 * - 16 to 19: hair

    82

 * - 20 to 22: eye color

    83

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

    84

 * - 28 to 30: glasses

    85

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

    86

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

    87

 *

    88

 * @param face the face in the old format

    89

 * @return the face in the new format

    90

 */

    91

PlayerFace ConvertFromOldPlayerFace(uint32 face)

    92

{

    93

	PlayerFace pf = 0;

    94

	GenderEthnicity ge = GE_WM;

    95

    96

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

    97

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

    98

    99

	SetPlayerFaceBits(pf, PFV_GEN_ETHN,    ge, ge);

   100

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

   101

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

   102

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

   103

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

   104

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

   105

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

   106

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

   107

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

   108

   109

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

   110

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

   111

		SetPlayerFaceBits(pf, PFV_HAS_MOUSTACHE, ge, true);

   112

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

   113

	} else {

   114

		if (!HasBit(ge, GENDER_FEMALE)) {

   115

			lips = lips * 15 / 16;

   116

			lips -= 3;

   117

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

   118

		} else {

   119

			lips = ScalePlayerFaceValue(PFV_LIPS, ge, lips);

   120

		}

   121

		SetPlayerFaceBits(pf, PFV_LIPS, ge, lips);

   122

   123

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

   124

		if (ge == GE_WF) {

   125

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

   126

		} else {

   127

			nose = ScalePlayerFaceValue(PFV_NOSE, ge, nose);

   128

		}

   129

		SetPlayerFaceBits(pf, PFV_NOSE, ge, nose);

   130

	}

   131

   132

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

   133

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

   134

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

   135

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

   136

	}

   137

   138

	return pf;

   139

}

   140

   141

/**

   142

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

   143

 * Unused bits are not enforced to be 0.

   144

 * @param pf the fact to check

   145

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

   146

 */

   147

bool IsValidPlayerFace(PlayerFace pf)

   148

{

   149

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

   150

   151

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

   152

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

   153

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

   154

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

   155

   156

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

   157

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

   158

		switch (pfv) {

   159

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

   160

			case PFV_LIPS:        /* FALL THROUGH */

   161

			case PFV_NOSE:        if (has_moustache)    continue; break;

   162

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

   163

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

   164

			default: break;

   165

		}

   166

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

   167

	}

   168

   169

	return true;

   170

}

   171

   172

void InvalidatePlayerWindows(const Player *p)

   173

{

   174

	PlayerID pid = p->index;

   175

   176

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

   177

	InvalidateWindow(WC_FINANCES, pid);

   178

}

   179

   180

bool CheckPlayerHasMoney(CommandCost cost)

   181

{

   182

	if (cost.GetCost() > 0) {

   183

		PlayerID pid = _current_player;

   184

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

   185

			SetDParam(0, cost.GetCost());

   186

			_error_message = STR_0003_NOT_ENOUGH_CASH_REQUIRES;

   187

			return false;

   188

		}

   189

	}

   190

	return true;

   191

}

   192

   193

static void SubtractMoneyFromAnyPlayer(Player *p, CommandCost cost)

   194

{

   197

   200

   201

	if (HasBit(1 << EXPENSES_TRAIN_INC    |

   202

	           1 << EXPENSES_ROADVEH_INC  |

   203

	           1 << EXPENSES_AIRCRAFT_INC |

   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     |

   213

	}

   214

   215

	InvalidatePlayerWindows(p);

   216

}

   217

   218

void SubtractMoneyFromPlayer(CommandCost cost)

   219

{

   220

	PlayerID pid = _current_player;

   221

   222

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

   223

}

   224

   225

void SubtractMoneyFromPlayerFract(PlayerID player, CommandCost cst)

   226

{

   227

	Player *p = GetPlayer(player);

   228

	byte m = p->player_money_fraction;

   229

	Money cost = cst.GetCost();

   230

   231

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

   232

	cost >>= 8;

   233

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

   235

}

   236

   237

void GetNameOfOwner(Owner owner, TileIndex tile)

   238

{

   239

	SetDParam(2, owner);

   240

   241

	if (owner != OWNER_TOWN) {

   242

		if (!IsValidPlayer(owner)) {

   243

			SetDParam(0, STR_0150_SOMEONE);

   244

		} else {

   245

			const Player* p = GetPlayer(owner);

   246

   247

			SetDParam(0, STR_COMPANY_NAME);

   248

			SetDParam(1, p->index);

   249

		}

   250

	} else {

   251

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

   252

   253

		SetDParam(0, STR_TOWN);

   254

		SetDParam(1, t->index);

   255

	}

   256

}

   257

   258

   259

bool CheckOwnership(PlayerID owner)

   260

{

   261

	assert(owner < OWNER_END);

   262

   263

	if (owner == _current_player) return true;

   264

	_error_message = STR_013B_OWNED_BY;

   265

	GetNameOfOwner(owner, 0);

   266

	return false;

   267

}

   268

   269

bool CheckTileOwnership(TileIndex tile)

   270

{

   271

	Owner owner = GetTileOwner(tile);

   272

   273

	assert(owner < OWNER_END);

   274

   275

	if (owner == _current_player) return true;

   276

	_error_message = STR_013B_OWNED_BY;

   277

   278

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

   279

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

   280

	return false;

   281

}

   282

   283

static void GenerateCompanyName(Player *p)

   284

{

   285

	TileIndex tile;

   286

	Town *t;

   287

	StringID str;

   288

	Player *pp;

   289

	uint32 strp;

   290

	char buffer[100];

   291

   292

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

   293

   294

	tile = p->last_build_coordinate;

   295

	if (tile == 0) return;

   296

   297

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

   298

   299

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

   300

		str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_PLAYERNAME_START;

   301

		strp = t->townnameparts;

   302

   303

verify_name:;

   304

		/* No player must have this name already */

   305

		FOR_ALL_PLAYERS(pp) {

   306

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

   307

		}

   308

   309

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

   310

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

   311

			goto bad_town_name;

   312

   313

set_name:;

   314

		p->name_1 = str;

   315

		p->name_2 = strp;

   316

   317

		MarkWholeScreenDirty();

   318

   319

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

   320

			SetDParam(0, t->index);

   321

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

   322

		}

   323

		return;

   324

	}

   325

bad_town_name:;

   326

   327

	if (p->president_name_1 == SPECSTR_PRESIDENT_NAME) {

   328

		str = SPECSTR_ANDCO_NAME;

   329

		strp = p->president_name_2;

   330

		goto set_name;

   331

	} else {

   332

		str = SPECSTR_ANDCO_NAME;

   333

		strp = Random();

   334

		goto verify_name;

   335

	}

   336

}

   337

   338

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

   339

   340

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

   341

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

   342

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

   343

   344

static byte GeneratePlayerColor()

   345

{

   346

	byte colors[16], pcolor, t2;

   347

	int i,j,n;

   348

	uint32 r;

   349

	Player *p;

   350

   351

	/* Initialize array */

   352

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

   353

   354

	/* And randomize it */

   355

	n = 100;

   356

	do {

   357

		r = Random();

   358

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

   359

	} while (--n);

   360

   361

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

   362

	i = 16;

   363

	do {

   364

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

   365

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

   366

				COLOR_SWAP(j, j + 1);

   367

			}

   368

		}

   369

	} while (--i);

   370

   371

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

   372

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

   373

		pcolor = p->player_color;

   374

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

   375

			colors[i] = 0xFF;

   376

   377

			t2 = _color_similar_1[pcolor];

   378

			if (t2 == 0xFF) break;

   379

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

   380

				if (colors[i] == t2) {

   381

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

   382

					break;

   383

				}

   384

			}

   385

   386

			t2 = _color_similar_2[pcolor];

   387

			if (t2 == 0xFF) break;

   388

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

   389

				if (colors[i] == t2) {

   390

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

   391

					break;

   392

				}

   393

			}

   394

			break;

   395

		}

   396

	}

   397

   398

	/* Return the first available color */

   399

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

   400

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

   401

	}

   402

}

   403

   404

static void GeneratePresidentName(Player *p)

   405

{

   406

	Player *pp;

   407

	char buffer[100], buffer2[40];

   408

   409

	for (;;) {

   410

restart:;

   411

   412

		p->president_name_2 = Random();

   413

		p->president_name_1 = SPECSTR_PRESIDENT_NAME;

   414

   415

		SetDParam(0, p->index);

   416

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

   417

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

   418

			continue;

   419

   420

		FOR_ALL_PLAYERS(pp) {

   421

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

   422

				SetDParam(0, pp->index);

   423

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

   424

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

   425

					goto restart;

   426

			}

   427

		}

   428

		return;

   429

	}

   430

}

   431

   432

static Player *AllocatePlayer()

   433

{

   434

	Player *p;

   435

	/* Find a free slot */

   436

	FOR_ALL_PLAYERS(p) {

   437

		if (!p->is_active) {

   438

			PlayerID i = p->index;

   439

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

   440

			memset(&_players_ai[i], 0, sizeof(PlayerAI));

   441

			memset(&_players_ainew[i], 0, sizeof(PlayerAiNew));

   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

/**

   459

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

   460

 *

   461

 * @param is_ai is a ai player?

   462

 * @return the player struct

   463

 */

   464

Player *DoStartupNewPlayer(bool is_ai)

   465

{

   466

	Player *p;

   467

   468

	p = AllocatePlayer();

   469

	if (p == NULL) return NULL;

   470

   471

	/* Make a color */

   472

	p->player_color = GeneratePlayerColor();

   473

	ResetPlayerLivery(p);

   474

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

   475

	p->name_1 = STR_SV_UNNAMED;

   476

	p->is_active = true;

   477

   478

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

   479

   480

	p->is_ai = is_ai;

   481

	_players_ai[p->index].state = 5; // AIS_WANT_NEW_ROUTE

   482

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

   483

   484

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

   485

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

   486

	p->inaugurated_year = _cur_year;

   487

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

   488

   489

	/* Engine renewal settings */

   490

	p->engine_renew_list = NULL;

   491

	p->renew_keep_length = false;

   492

	p->engine_renew = _patches_newgame.autorenew;

   493

	p->engine_renew_months = _patches_newgame.autorenew_months;