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

#include "group.h"

    24

    25

EngineInfo _engine_info[TOTAL_NUM_ENGINES];

    26

RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

    27

ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

    28

AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

    29

RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

    30

    31

enum {

    32

	YEAR_ENGINE_AGING_STOPS = 2050,

    33

};

    34

    35

    36

void ShowEnginePreviewWindow(EngineID engine);

    37

    38

void DeleteCustomEngineNames()

    39

{

    40

	uint i;

    41

	StringID old;

    42

    43

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

    44

		old = _engine_name_strings[i];

    45

		_engine_name_strings[i] = i + STR_8000_KIRBY_PAUL_TANK_STEAM;

    46

		DeleteName(old);

    47

	}

    48

    49

	_vehicle_design_names &= ~1;

    50

}

    51

    52

void LoadCustomEngineNames()

    53

{

    54

	/* XXX: not done */

    55

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

    56

}

    57

    58

static void SetupEngineNames()

    59

{

    60

	StringID *name;

    61

    62

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

    63

		*name = STR_SV_EMPTY;

    64

    65

	DeleteCustomEngineNames();

    66

	LoadCustomEngineNames();

    67

}

    68

    69

    70

static void CalcEngineReliability(Engine *e)

    71

{

    72

	uint age = e->age;

    73

    74

	/* Check for early retirement */

    75

	if (e->player_avail != 0 && !_patches.never_expire_vehicles) {

    76

		uint retire_early = EngInfo(e - _engines)->retire_early;

    77

		if (retire_early > 0 && age >= e->duration_phase_1 + e->duration_phase_2 - retire_early * 12) {

    78

			/* Early retirement is enabled and we're past the date... */

    79

			e->player_avail = 0;

    80

			AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

    81

		}

    82

	}

    83

    84

	if (age < e->duration_phase_1) {

    85

		uint start = e->reliability_start;

    86

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

    87

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

    88

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

    89

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

    90

		e->reliability = e->reliability_max;

    91

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

    92

		uint max = e->reliability_max;

    93

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

    94

	} else {

    95

		/* time's up for this engine.

    96

		 * We will now completely retire this design */

    97

		e->player_avail = 0;

    98

		e->reliability = e->reliability_final;

    99

		/* Kick this engine out of the lists */

   100

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   101

	}

   102

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

   103

	InvalidateWindowClasses(WC_REPLACE_VEHICLE);

   104

}

   105

   106

void AddTypeToEngines()

   107

{

   108

	Engine* e = _engines;

   109

   110

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

   111

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

   112

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

   113

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

   114

}

   115

   116

void StartupEngines()

   117

{

   118

	Engine *e;

   119

	const EngineInfo *ei;

   120

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

   121

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

   122

   123

	SetupEngineNames();

   124

   125

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

   126

		uint32 r;

   127

   128

		e->age = 0;

   129

		e->flags = 0;

   130

		e->player_avail = 0;

   131

   132

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

   133

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

   134

		 * added. */

   135

		r = Random();

   136

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

   137

		if (e->intro_date <= _date) {

   138

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

   139

			e->player_avail = (byte)-1;

   140

			e->flags |= ENGINE_AVAILABLE;

   141

		}

   142

   143

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

   144

		r = Random();

   145

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

   146

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

   147

   148

		r = Random();

   149

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

   150

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

   151

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

   152

   153

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

   154

   155

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

   156

		if (ei->unk2 & 0x80) {

   157

			e->age = 0xFFFF;

   158

		} else {

   159

			CalcEngineReliability(e);

   160

		}

   161

   162

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

   163

   164

		/* prevent certain engines from ever appearing. */

   165

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

   166

			e->flags |= ENGINE_AVAILABLE;

   167

			e->player_avail = 0;

   168

		}

   169

   170

		/* This sets up type for the engine

   171

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

   172

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

   173

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

   174

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

   175

	}

   176

}

   177

   178

static void AcceptEnginePreview(EngineID eid, PlayerID player)

   179

{

   180

	Engine *e = GetEngine(eid);

   181

	Player *p = GetPlayer(player);

   182

   183

	SETBIT(e->player_avail, player);

   184

	if (e->type == VEH_TRAIN) {

   185

		const RailVehicleInfo *rvi = RailVehInfo(eid);

   186

   187

		assert(rvi->railtype < RAILTYPE_END);

   188

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

   189

	} else if (e->type == VEH_ROAD) {

   190

		SETBIT(p->avail_roadtypes, HASBIT(EngInfo(eid)->misc_flags, EF_ROAD_TRAM) ? ROADTYPE_TRAM : ROADTYPE_ROAD);

   191

	}

   192

   193

	e->preview_player = INVALID_PLAYER;

   194

	if (player == _local_player) {

   195

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   196

	}

   197

}

   198

   199

static PlayerID GetBestPlayer(PlayerID pp)

   200

{

   201

	const Player *p;

   202

	int32 best_hist;

   203

	PlayerID best_player;

   204

	uint mask = 0;

   205

   206

	do {

   207

		best_hist = -1;

   208

		best_player = PLAYER_SPECTATOR;

   209

		FOR_ALL_PLAYERS(p) {

   210

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

   211

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

   212

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

   213

				best_player = p->index;

   214

			}

   215

		}

   216

   217

		if (best_player == PLAYER_SPECTATOR) return PLAYER_SPECTATOR;

   218

   219

		SETBIT(mask, best_player);

   220

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

   221

   222

	return best_player;

   223

}

   224

   225

void EnginesDailyLoop()

   226

{

   227

	EngineID i;

   228

   229

	if (_cur_year >= YEAR_ENGINE_AGING_STOPS) return;

   230

   231

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

   232

		Engine *e = &_engines[i];

   233

   234

		if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   235

			if (e->flags & ENGINE_OFFER_WINDOW_OPEN) {

   236

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

   237

					e->flags &= ~ENGINE_OFFER_WINDOW_OPEN;

   238

					DeleteWindowById(WC_ENGINE_PREVIEW, i);

   239

					e->preview_player++;

   240

				}

   241

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

   242

				PlayerID best_player = GetBestPlayer(e->preview_player);

   243

   244

				if (best_player == PLAYER_SPECTATOR) {

   245

					e->preview_player = INVALID_PLAYER;

   246

					continue;

   247

				}

   248

   249

				if (!IsHumanPlayer(best_player)) {

   250

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

   251

					AcceptEnginePreview(i, best_player);

   252

				} else {

   253

					e->flags |= ENGINE_OFFER_WINDOW_OPEN;

   254

					e->preview_wait = 20;

   255

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

   256

				}

   257

			}

   258

		}

   259

	}

   260

}

   261

   262

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

   263

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

   264

 * @param tile unused

   265

 * @param flags operation to perfom

   266

 * @param p1 engine-prototype offered

   267

 * @param p2 unused

   268

 */

   269

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

   270

{

   271

	Engine *e;

   272

   273

	if (!IsEngineIndex(p1)) return CMD_ERROR;

   274

	e = GetEngine(p1);

   275

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

   276

   277

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

   278

   279

	return 0;

   280

}

   281

   282

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

   283

static bool IsWagon(EngineID index)

   284

{

   285

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

   286

}

   287

   288

static void NewVehicleAvailable(Engine *e)

   289

{

   290

	Vehicle *v;

   291

	Player *p;

   292

	EngineID index = e - _engines;

   293

   294

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

   295

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

   296

	if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   297

		FOR_ALL_PLAYERS(p) {

   298

			uint block_preview = p->block_preview;

   299

   300

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

   301

   302

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

   303

			p->block_preview = 20;

   304

   305

			FOR_ALL_VEHICLES(v) {

   306

				if (v->type == VEH_TRAIN || v->type == VEH_ROAD || v->type == VEH_SHIP ||

   307

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

   308

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

   309

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

   310

						p->block_preview = block_preview;

   311

						break;

   312

					}

   313

				}

   314

			}

   315

		}

   316

	}

   317

   318

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

   319

	AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   320

   321

	/* Now available for all players */

   322

	e->player_avail = (byte)-1;

   323

   324

	/* Do not introduce new rail wagons */

   325

	if (IsWagon(index)) return;

   326

   327

	if (index < NUM_TRAIN_ENGINES) {

   328

		/* maybe make another rail type available */

   329

		RailType railtype = RailVehInfo(index)->railtype;

   330

		assert(railtype < RAILTYPE_END);

   331

		FOR_ALL_PLAYERS(p) {

   332

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

   333

		}

   334

	}

   335

	if ((index - NUM_TRAIN_ENGINES) < NUM_ROAD_ENGINES) {

   336

		/* maybe make another road type available */

   337

		FOR_ALL_PLAYERS(p) {

   338

			if (p->is_active) SETBIT(p->avail_roadtypes, HASBIT(EngInfo(index)->misc_flags, EF_ROAD_TRAM) ? ROADTYPE_TRAM : ROADTYPE_ROAD);

   339

		}

   340

	}

   341

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

   342

}

   343

   344

void EnginesMonthlyLoop()

   345

{

   346

	Engine *e;

   347

   348

	if (_cur_year < YEAR_ENGINE_AGING_STOPS) {

   349

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

   350

			/* Age the vehicle */

   351

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

   352

				e->age++;

   353

				CalcEngineReliability(e);

   354

			}

   355

   356

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

   357

				/* Introduce it to all players */

   358

				NewVehicleAvailable(e);

   359

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

   360

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

   361

				e->flags |= ENGINE_EXCLUSIVE_PREVIEW;

   362

   363

				/* Do not introduce new rail wagons */

   364

				if (!IsWagon(e - _engines))

   365

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

   366

			}

   367

		}

   368

	}

   369

}

   370

   371

/** Rename an engine.

   372

 * @param tile unused

   373

 * @param flags operation to perfom

   374

 * @param p1 engine ID to rename

   375

 * @param p2 unused

   376

 */

   377

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

   378

{

   379

	StringID str;

   380

   381

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

   382

   383

	str = AllocateNameUnique(_cmd_text, 0);

   384

	if (str == 0) return CMD_ERROR;

   385

   386

	if (flags & DC_EXEC) {

   387

		StringID old_str = _engine_name_strings[p1];

   388

		_engine_name_strings[p1] = str;

   389

		DeleteName(old_str);

   390

		_vehicle_design_names |= 3;

   391

		MarkWholeScreenDirty();

   392

	} else {

   393

		DeleteName(str);

   394

	}

   395

   396

	return 0;

   397

}

   398

   399

   400

/*

   401

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

   402

 * the given player, false otherwise

   403

 *

   404

 * engine = index of the engine to check

   405

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

   406

 * player = index of the player

   407

 */

   408

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

   409

{

   410

	const Engine *e;

   411

   412

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

   413

	if (!IsEngineIndex(engine)) return false;

   414

   415

	e = GetEngine(engine);

   416

   417

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

   418

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

   419

   420

	/* check if it's available */

   421

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

   422

   423

	if (type == VEH_TRAIN) {

   424

		/* Check if the rail type is available to this player */

   425

		const Player *p = GetPlayer(player);

   426

		if (!HASBIT(p->avail_railtypes, RailVehInfo(engine)->railtype)) return false;

   427

	}

   428

   429

	return true;

   430

}

   431

   432

/** Get the default cargo type for a certain engine type

   433

 * @param engine The ID to get the cargo for

   434

 * @return The cargo type. CT_INVALID means no cargo capacity

   435

 */

   436

CargoID GetEngineCargoType(EngineID engine)

   437

{

   438

	assert(IsEngineIndex(engine));

   439

   440

	switch (GetEngine(engine)->type) {

   441

		case VEH_TRAIN:

   442

			if (RailVehInfo(engine)->capacity == 0) return CT_INVALID;

   443

			return RailVehInfo(engine)->cargo_type;

   444

   445

		case VEH_ROAD:

   446

			if (RoadVehInfo(engine)->capacity == 0) return CT_INVALID;

   447

			return RoadVehInfo(engine)->cargo_type;

   448

   449

		case VEH_SHIP:

   450

			if (ShipVehInfo(engine)->capacity == 0) return CT_INVALID;

   451

			return ShipVehInfo(engine)->cargo_type;

   452

   453

		case VEH_AIRCRAFT:

   454

			/* all aircraft starts as passenger planes with cargo capacity */

   455

			return CT_PASSENGERS;

   456

   457

		default: NOT_REACHED(); return CT_INVALID;

   458

	}

   459

}

   460

   461

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

   462

 * Engine Replacement stuff

   463

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

   464

   465

static void EngineRenewPoolNewBlock(uint start_item);

   466

   467

DEFINE_OLD_POOL(EngineRenew, EngineRenew, EngineRenewPoolNewBlock, NULL)

   468

   469

static void EngineRenewPoolNewBlock(uint start_item)

   470

{

   471

	EngineRenew *er;

   472

   473

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

   474

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

   475

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

   476

		er->index = start_item++;

   477

		er->from = INVALID_ENGINE;

   478

	}

   479

}

   480

   481

   482

static EngineRenew *AllocateEngineRenew()

   483

{

   484

	EngineRenew *er;

   485

   486

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

   487

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

   488

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

   489

		if (IsValidEngineRenew(er)) continue;

   490

   491

		er->to = INVALID_ENGINE;