1

/* $Id$ */

     2

     3

/** @file engine.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "table/strings.h"

    10

#include "engine.h"

    11

#include "gfx.h"

    12

#include "player.h"

    13

#include "command.h"

    14

#include "vehicle.h"

    15

#include "news.h"

    16

#include "saveload.h"

    17

#include "variables.h"

    18

#include "train.h"

    19

#include "aircraft.h"

    20

#include "newgrf_cargo.h"

    21

#include "date.h"

    22

#include "table/engines.h"

    23

    24

EngineInfo _engine_info[TOTAL_NUM_ENGINES];

    25

RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

    26

ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

    27

AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

    28

RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

    29

    30

enum {

    31

	ENGINE_AVAILABLE   = 1,

    32

	ENGINE_INTRODUCING = 2,

    33

	ENGINE_PREVIEWING  = 4,

    34

};

    35

    36

enum {

    37

	YEAR_ENGINE_AGING_STOPS = 2050,

    38

};

    39

    40

    41

void ShowEnginePreviewWindow(EngineID engine);

    42

    43

void DeleteCustomEngineNames(void)

    44

{

    45

	uint i;

    46

	StringID old;

    47

    48

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

    49

		old = _engine_name_strings[i];

    50

		_engine_name_strings[i] = i + STR_8000_KIRBY_PAUL_TANK_STEAM;

    51

		DeleteName(old);

    52

	}

    53

    54

	_vehicle_design_names &= ~1;

    55

}

    56

    57

void LoadCustomEngineNames(void)

    58

{

    59

	/* XXX: not done */

    60

	DEBUG(misc, 1, "LoadCustomEngineNames: not done");

    61

}

    62

    63

static void SetupEngineNames(void)

    64

{

    65

	StringID *name;

    66

    67

	for (name = _engine_name_strings; name != endof(_engine_name_strings); name++)

    68

		*name = STR_SV_EMPTY;

    69

    70

	DeleteCustomEngineNames();

    71

	LoadCustomEngineNames();

    72

}

    73

    74

    75

static void CalcEngineReliability(Engine *e)

    76

{

    77

	uint age = e->age;

    78

    79

	if (age < e->duration_phase_1) {

    80

		uint start = e->reliability_start;

    81

		e->reliability = age * (e->reliability_max - start) / e->duration_phase_1 + start;

    82

	} else if ((age -= e->duration_phase_1) < e->duration_phase_2 || _patches.never_expire_vehicles) {

    83

		/* We are at the peak of this engines life. It will have max reliability.

    84

		 * This is also true if the engines never expire. They will not go bad over time */

    85

		e->reliability = e->reliability_max;

    86

	} else if ((age -= e->duration_phase_2) < e->duration_phase_3) {

    87

		uint max = e->reliability_max;

    88

		e->reliability = (int)age * (int)(e->reliability_final - max) / e->duration_phase_3 + max;

    89

	} else {

    90

		/* time's up for this engine.

    91

		 * We will now completely retire this design */

    92

		e->player_avail = 0;

    93

		e->reliability = e->reliability_final;

    94

		/* Kick this engine out of the lists */

    95

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

    96

	}

    97

	InvalidateWindowClasses(WC_BUILD_VEHICLE); // Update to show the new reliability

    98

	InvalidateWindowClasses(WC_REPLACE_VEHICLE);

    99

}

   100

   101

void AddTypeToEngines(void)

   102

{

   103

	Engine* e = _engines;

   104

   105

	do e->type = VEH_Train;    while (++e < &_engines[ROAD_ENGINES_INDEX]);

   106

	do e->type = VEH_Road;     while (++e < &_engines[SHIP_ENGINES_INDEX]);

   107

	do e->type = VEH_Ship;     while (++e < &_engines[AIRCRAFT_ENGINES_INDEX]);

   108

	do e->type = VEH_Aircraft; while (++e < &_engines[TOTAL_NUM_ENGINES]);

   109

}

   110

   111

void StartupEngines(void)

   112

{

   113

	Engine *e;

   114

	const EngineInfo *ei;

   115

	/* Aging of vehicles stops, so account for that when starting late */

   116

	const Date aging_date = min(_date, ConvertYMDToDate(YEAR_ENGINE_AGING_STOPS, 0, 1));

   117

   118

	SetupEngineNames();

   119

   120

	for (e = _engines, ei = _engine_info; e != endof(_engines); e++, ei++) {

   121

		uint32 r;

   122

   123

		e->age = 0;

   124

		e->flags = 0;

   125

		e->player_avail = 0;

   126

   127

		/* The magic value of 729 days below comes from the NewGRF spec. If the

   128

		 * base intro date is before 1922 then the random number of days is not

   129

		 * added. */

   130

		r = Random();

   131

		e->intro_date = ei->base_intro <= ConvertYMDToDate(1922, 0, 1) ? ei->base_intro : (Date)GB(r, 0, 9) + ei->base_intro;

   132

		if (e->intro_date <= _date) {

   133

			e->age = (aging_date - e->intro_date) >> 5;

   134

			e->player_avail = (byte)-1;

   135

			e->flags |= ENGINE_AVAILABLE;

   136

		}

   137

   138

		e->reliability_start = GB(r, 16, 14) + 0x7AE0;

   139

		r = Random();

   140

		e->reliability_max   = GB(r,  0, 14) + 0xBFFF;

   141

		e->reliability_final = GB(r, 16, 14) + 0x3FFF;

   142

   143

		r = Random();

   144

		e->duration_phase_1 = GB(r, 0, 5) + 7;

   145

		e->duration_phase_2 = GB(r, 5, 4) + ei->base_life * 12 - 96;

   146

		e->duration_phase_3 = GB(r, 9, 7) + 120;

   147

   148

		e->reliability_spd_dec = (ei->unk2&0x7F) << 2;

   149

   150

		/* my invented flag for something that is a wagon */

   151

		if (ei->unk2 & 0x80) {

   152

			e->age = 0xFFFF;

   153

		} else {

   154

			CalcEngineReliability(e);

   155

		}

   156

   157

		e->lifelength = ei->lifelength + _patches.extend_vehicle_life;

   158

   159

		/* prevent certain engines from ever appearing. */

   160

		if (!HASBIT(ei->climates, _opt.landscape)) {

   161

			e->flags |= ENGINE_AVAILABLE;

   162

			e->player_avail = 0;

   163

		}

   164

   165

		/* This sets up type for the engine

   166

		 * It is needed if you want to ask the engine what type it is

   167

		 * It should hopefully be the same as when you ask a vehicle what it is

   168

		 * but using this, you can ask what type an engine number is

   169

		 * even if it is not a vehicle (yet)*/

   170

	}

   171

}

   172

   173

static void AcceptEnginePreview(EngineID eid, PlayerID player)

   174

{

   175

	Engine *e = GetEngine(eid);

   176

   177

	SETBIT(e->player_avail, player);

   178

	if (e->type == VEH_Train) {

   179

		const RailVehicleInfo *rvi = RailVehInfo(eid);

   180

		Player *p = GetPlayer(player);

   181

   182

		assert(rvi->railtype < RAILTYPE_END);

   183

		SETBIT(p->avail_railtypes, rvi->railtype);

   184

	}

   185

   186

	e->preview_player = INVALID_PLAYER;

   187

	if (player == _local_player) {

   188

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   189

	}

   190

}

   191

   192

static PlayerID GetBestPlayer(PlayerID pp)

   193

{

   194

	const Player *p;

   195

	int32 best_hist;

   196

	PlayerID best_player;

   197

	uint mask = 0;

   198

   199

	do {

   200

		best_hist = -1;

   201

		best_player = PLAYER_SPECTATOR;

   202

		FOR_ALL_PLAYERS(p) {

   203

			if (p->is_active && p->block_preview == 0 && !HASBIT(mask, p->index) &&

   204

					p->old_economy[0].performance_history > best_hist) {

   205

				best_hist = p->old_economy[0].performance_history;

   206

				best_player = p->index;

   207

			}

   208

		}

   209

   210

		if (best_player == PLAYER_SPECTATOR) return PLAYER_SPECTATOR;

   211

   212

		SETBIT(mask, best_player);

   213

	} while (pp--, pp != 0);

   214

   215

	return best_player;

   216

}

   217

   218

void EnginesDailyLoop(void)

   219

{

   220

	EngineID i;

   221

   222

	if (_cur_year >= YEAR_ENGINE_AGING_STOPS) return;

   223

   224

	for (i = 0; i != lengthof(_engines); i++) {

   225

		Engine *e = &_engines[i];

   226

   227

		if (e->flags & ENGINE_INTRODUCING) {

   228

			if (e->flags & ENGINE_PREVIEWING) {

   229

				if (e->preview_player != 0xFF && !--e->preview_wait) {

   230

					e->flags &= ~ENGINE_PREVIEWING;

   231

					DeleteWindowById(WC_ENGINE_PREVIEW, i);

   232

					e->preview_player++;

   233

				}

   234

			} else if (e->preview_player != 0xFF) {

   235

				PlayerID best_player = GetBestPlayer(e->preview_player);

   236

   237

				if (best_player == PLAYER_SPECTATOR) {

   238

					e->preview_player = INVALID_PLAYER;

   239

					continue;

   240

				}

   241

   242

				if (!IsHumanPlayer(best_player)) {

   243

					/* XXX - TTDBUG: TTD has a bug here ???? */

   244

					AcceptEnginePreview(i, best_player);

   245

				} else {

   246

					e->flags |= ENGINE_PREVIEWING;

   247

					e->preview_wait = 20;

   248

					if (IsInteractivePlayer(best_player)) ShowEnginePreviewWindow(i);

   249

				}

   250

			}

   251

		}

   252

	}

   253

}

   254

   255

/** Accept an engine prototype. XXX - it is possible that the top-player

   256

 * changes while you are waiting to accept the offer? Then it becomes invalid

   257

 * @param tile unused

   258

 * @param p1 engine-prototype offered

   259

 * @param p2 unused

   260

 */

   261

int32 CmdWantEnginePreview(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   262

{

   263

	Engine *e;

   264

   265

	if (!IsEngineIndex(p1)) return CMD_ERROR;

   266

	e = GetEngine(p1);

   267

	if (GetBestPlayer(e->preview_player) != _current_player) return CMD_ERROR;

   268

   269

	if (flags & DC_EXEC) AcceptEnginePreview(p1, _current_player);

   270

   271

	return 0;

   272

}

   273

   274

/* Determine if an engine type is a wagon (and not a loco) */

   275

static bool IsWagon(EngineID index)

   276

{

   277

	return index < NUM_TRAIN_ENGINES && RailVehInfo(index)->railveh_type == RAILVEH_WAGON;

   278

}

   279

   280

static void NewVehicleAvailable(Engine *e)

   281

{

   282

	Vehicle *v;

   283

	Player *p;

   284

	EngineID index = e - _engines;

   285

   286

	/* In case the player didn't build the vehicle during the intro period,

   287

	 * prevent that player from getting future intro periods for a while. */

   288

	if (e->flags & ENGINE_INTRODUCING) {

   289

		FOR_ALL_PLAYERS(p) {

   290

			uint block_preview = p->block_preview;

   291

   292

			if (!HASBIT(e->player_avail, p->index)) continue;

   293

   294

			/* We assume the user did NOT build it.. prove me wrong ;) */

   295

			p->block_preview = 20;

   296

   297

			FOR_ALL_VEHICLES(v) {

   298

				if (v->type == VEH_Train || v->type == VEH_Road || v->type == VEH_Ship ||

   299

						(v->type == VEH_Aircraft && IsNormalAircraft(v))) {

   300

					if (v->owner == p->index && v->engine_type == index) {

   301

						/* The user did prove me wrong, so restore old value */

   302

						p->block_preview = block_preview;

   303

						break;

   304

					}

   305

				}

   306

			}

   307

		}

   308

	}

   309

   310

	e->flags = (e->flags & ~ENGINE_INTRODUCING) | ENGINE_AVAILABLE;

   311

	AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   312

   313

	/* Now available for all players */

   314

	e->player_avail = (byte)-1;

   315

   316

	/* Do not introduce new rail wagons */

   317

	if (IsWagon(index)) return;

   318

   319

	if (index < NUM_TRAIN_ENGINES) {

   320

		/* maybe make another rail type available */

   321

		RailType railtype = RailVehInfo(index)->railtype;

   322

		assert(railtype < RAILTYPE_END);

   323

		FOR_ALL_PLAYERS(p) {

   324

			if (p->is_active) SETBIT(p->avail_railtypes, railtype);

   325

		}

   326

   327

		AddNewsItem(index, NEWS_FLAGS(NM_CALLBACK, 0, NT_NEW_VEHICLES, DNC_TRAINAVAIL), 0, 0);

   328

	} else if (index < NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES) {

   329

		AddNewsItem(index, NEWS_FLAGS(NM_CALLBACK, 0, NT_NEW_VEHICLES, DNC_ROADAVAIL), 0, 0);

   330

	} else if (index < NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES) {

   331

		AddNewsItem(index, NEWS_FLAGS(NM_CALLBACK, 0, NT_NEW_VEHICLES, DNC_SHIPAVAIL), 0, 0);

   332

	} else {

   333

		AddNewsItem(index, NEWS_FLAGS(NM_CALLBACK, 0, NT_NEW_VEHICLES, DNC_AIRCRAFTAVAIL), 0, 0);

   334

	}

   335

}

   336

   337

void EnginesMonthlyLoop(void)

   338

{

   339

	Engine *e;

   340

   341

	if (_cur_year < YEAR_ENGINE_AGING_STOPS) {

   342

		for (e = _engines; e != endof(_engines); e++) {

   343

			/* Age the vehicle */

   344

			if (e->flags & ENGINE_AVAILABLE && e->age != 0xFFFF) {

   345

				e->age++;

   346

				CalcEngineReliability(e);

   347

			}

   348

   349

			if (!(e->flags & ENGINE_AVAILABLE) && _date >= (e->intro_date + 365)) {

   350

				/* Introduce it to all players */

   351

				NewVehicleAvailable(e);

   352

			} else if (!(e->flags & (ENGINE_AVAILABLE|ENGINE_INTRODUCING)) && _date >= e->intro_date) {

   353

				/* Introduction date has passed.. show introducing dialog to one player. */

   354

				e->flags |= ENGINE_INTRODUCING;

   355

   356

				/* Do not introduce new rail wagons */

   357

				if (!IsWagon(e - _engines))

   358

					e->preview_player = (PlayerID)1; // Give to the player with the highest rating.

   359

			}

   360

		}

   361

	}

   362

}

   363

   364

/** Rename an engine.

   365

 * @param tile unused

   366

 * @param p1 engine ID to rename

   367

 * @param p2 unused

   368

 */

   369

int32 CmdRenameEngine(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   370

{

   371

	StringID str;

   372

   373

	if (!IsEngineIndex(p1) || _cmd_text[0] == '\0') return CMD_ERROR;

   374

   375

	str = AllocateNameUnique(_cmd_text, 0);

   376

	if (str == 0) return CMD_ERROR;

   377

   378

	if (flags & DC_EXEC) {

   379

		StringID old_str = _engine_name_strings[p1];

   380

		_engine_name_strings[p1] = str;

   381

		DeleteName(old_str);

   382

		_vehicle_design_names |= 3;

   383

		MarkWholeScreenDirty();

   384

	} else {

   385

		DeleteName(str);

   386

	}

   387

   388

	return 0;

   389

}

   390

   391

   392

/*

   393

 * returns true if an engine is valid, of the specified type, and buildable by

   394

 * the given player, false otherwise

   395

 *

   396

 * engine = index of the engine to check

   397

 * type   = the type the engine should be of (VEH_xxx)

   398

 * player = index of the player

   399

 */

   400

bool IsEngineBuildable(EngineID engine, byte type, PlayerID player)

   401

{

   402

	const Engine *e;

   403

   404

	/* check if it's an engine that is in the engine array */

   405

	if (!IsEngineIndex(engine)) return false;

   406

   407

	e = GetEngine(engine);

   408

   409

	/* check if it's an engine of specified type */

   410

	if (e->type != type) return false;

   411

   412

	/* check if it's available */

   413

	if (!HASBIT(e->player_avail, player)) return false;

   414

   415

	return true;

   416

}

   417

   418

/************************************************************************

   419

 * Engine Replacement stuff

   420

 ************************************************************************/

   421

   422

static void EngineRenewPoolNewBlock(uint start_item);

   423

   424

DEFINE_OLD_POOL(EngineRenew, EngineRenew, EngineRenewPoolNewBlock, NULL)

   425

   426

static void EngineRenewPoolNewBlock(uint start_item)

   427

{

   428

	EngineRenew *er;

   429

   430

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

   431

	 *  TODO - This is just a temporary stage, this will be removed. */

   432

	for (er = GetEngineRenew(start_item); er != NULL; er = (er->index + 1U < GetEngineRenewPoolSize()) ? GetEngineRenew(er->index + 1U) : NULL) {

   433

		er->index = start_item++;

   434

		er->from = INVALID_ENGINE;

   435

	}

   436

}

   437

   438

   439

static EngineRenew *AllocateEngineRenew(void)

   440

{

   441

	EngineRenew *er;

   442

   443

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

   444

	 *  TODO - This is just a temporary stage, this will be removed. */

   445

	for (er = GetEngineRenew(0); er != NULL; er = (er->index + 1U < GetEngineRenewPoolSize()) ? GetEngineRenew(er->index + 1U) : NULL) {

   446

		if (IsValidEngineRenew(er)) continue;

   447

   448

		er->to = INVALID_ENGINE;

   449

		er->next = NULL;

   450

		return er;

   451

	}

   452

   453

	/* Check if we can add a block to the pool */

   454

	if (AddBlockToPool(&_EngineRenew_pool)) return AllocateEngineRenew();

   455

   456

	return NULL;

   457

}

   458

   459

/**

   460

 * Retrieves the EngineRenew that specifies the replacement of the given

   461

 * engine type from the given renewlist */

   462

static EngineRenew *GetEngineReplacement(EngineRenewList erl, EngineID engine)

   463

{

   464

	EngineRenew *er = (EngineRenew *)erl;

   465

   466

	while (er) {

   467

		if (er->from == engine) return er;

   468

		er = er->next;

   469

	}

   470

	return NULL;

   471

}

   472

   473

void RemoveAllEngineReplacement(EngineRenewList *erl)

   474

{

   475

	EngineRenew *er = (EngineRenew *)(*erl);

   476

	EngineRenew *next;

   477

   478

	while (er) {

   479

		next = er->next;

   480

		DeleteEngineRenew(er);

   481

		er = next;

   482

	}

   483

	*erl = NULL; // Empty list

   484

}

   485

   486

EngineID EngineReplacement(EngineRenewList erl, EngineID engine)

   487

{

   488

	const EngineRenew *er = GetEngineReplacement(erl, engine);

   489

	return er == NULL ? INVALID_ENGINE : er->to;

   490

}

   491