1

/* $Id$ */

     2

     3

/** @file engine.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "engine.h"

     9

#include "player_base.h"

    10

#include "player_func.h"

    11

#include "command_func.h"

    12

#include "news.h"

    13

#include "saveload.h"

    14

#include "variables.h"

    15

#include "train.h"

    16

#include "aircraft.h"

    17

#include "newgrf_cargo.h"

    18

#include "group.h"

    19

#include "strings_func.h"

    20

#include "gfx_func.h"

    21

#include "functions.h"

    22

#include "window_func.h"

    23

#include "date_func.h"

    24

#include "autoreplace_base.h"

    25

#include "autoreplace_gui.h"

    26

#include "string_func.h"

    27

#include "settings_type.h"

    28

    29

#include "table/strings.h"

    30

#include "table/engines.h"

    31

    32

Engine _engines[TOTAL_NUM_ENGINES];

    33

EngineInfo _engine_info[TOTAL_NUM_ENGINES];

    34

RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

    35

ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

    36

AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

    37

RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

    38

    39

enum {

    40

	YEAR_ENGINE_AGING_STOPS = 2050,

    41

};

    42

    43

    44

void SetupEngines()

    45

{

    46

	/* Copy original static engine data */

    47

	memcpy(&_engine_info, &_orig_engine_info, sizeof(_orig_engine_info));

    48

	memcpy(&_rail_vehicle_info, &_orig_rail_vehicle_info, sizeof(_orig_rail_vehicle_info));

    49

	memcpy(&_ship_vehicle_info, &_orig_ship_vehicle_info, sizeof(_orig_ship_vehicle_info));

    50

	memcpy(&_aircraft_vehicle_info, &_orig_aircraft_vehicle_info, sizeof(_orig_aircraft_vehicle_info));

    51

	memcpy(&_road_vehicle_info, &_orig_road_vehicle_info, sizeof(_orig_road_vehicle_info));

    52

    53

	/* Add type to engines */

    54

	Engine* e = _engines;

    55

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

    56

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

    57

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

    58

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

    59

    60

	/* Set up default engine names */

    61

	for (EngineID engine = 0; engine < TOTAL_NUM_ENGINES; engine++) {

    62

		EngineInfo *ei = &_engine_info[engine];

    63

		ei->string_id = STR_8000_KIRBY_PAUL_TANK_STEAM + engine;

    64

	}

    65

}

    66

    67

    68

void ShowEnginePreviewWindow(EngineID engine);

    69

    70

void DeleteCustomEngineNames()

    71

{

    72

	Engine *e;

    73

	FOR_ALL_ENGINES(e) {

    74

		free(e->name);

    75

		e->name = NULL;

    76

	}

    77

    78

	_vehicle_design_names &= ~1;

    79

}

    80

    81

void LoadCustomEngineNames()

    82

{

    83

	/* XXX: not done */

    84

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

    85

}

    86

    87

static void CalcEngineReliability(Engine *e)

    88

{

    89

	uint age = e->age;

    90

    91

	/* Check for early retirement */

    92

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

    93

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

    94

		uint retire_early_max_age = max(0, e->duration_phase_1 + e->duration_phase_2 - retire_early * 12);

    95

		if (retire_early != 0 && age >= retire_early_max_age) {

    96

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

    97

			e->player_avail = 0;

    98

			AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

    99

		}

   100

	}

   101

   102

	if (age < e->duration_phase_1) {

   103

		uint start = e->reliability_start;

   104

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

   105

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

   106

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

   107

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

   108

		e->reliability = e->reliability_max;

   109

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

   110

		uint max = e->reliability_max;

   111

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

   112

	} else {

   113

		/* time's up for this engine.

   114

		 * We will now completely retire this design */

   115

		e->player_avail = 0;

   116

		e->reliability = e->reliability_final;

   117

		/* Kick this engine out of the lists */

   118

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   119

	}

   120

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

   121

	InvalidateWindowClasses(WC_REPLACE_VEHICLE);

   122

}

   123

   124

void StartupEngines()

   125

{

   126

	Engine *e;

   127

	const EngineInfo *ei;

   128

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

   129

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

   130

   131

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

   132

		uint32 r;

   133

   134

		e->age = 0;

   135

		e->flags = 0;

   136

		e->player_avail = 0;

   137

   138

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

   139

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

   140

		 * added. */

   141

		r = Random();

   142

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

   143

		if (e->intro_date <= _date) {

   144

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

   145

			e->player_avail = (byte)-1;

   146

			e->flags |= ENGINE_AVAILABLE;

   147

		}

   148

   149

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

   150

		r = Random();

   151

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

   152

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

   153

   154

		r = Random();

   155

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

   156

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

   157

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

   158

   159

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

   160

   161

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

   162

		if (ei->unk2 & 0x80) {

   163

			e->age = 0xFFFF;

   164

		} else {

   165

			CalcEngineReliability(e);

   166

		}

   167

   168

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

   169

   170

		/* prevent certain engines from ever appearing. */

   171

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

   172

			e->flags |= ENGINE_AVAILABLE;

   173

			e->player_avail = 0;

   174

		}

   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_rank = 0xFF;

   194

	if (player == _local_player) {

   195

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   196

	}

   197

}

   198

   199

static PlayerID GetBestPlayer(uint8 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 != 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_rank != 0xFF && !--e->preview_wait) {

   237

					e->flags &= ~ENGINE_OFFER_WINDOW_OPEN;

   238

					DeleteWindowById(WC_ENGINE_PREVIEW, i);

   239

					e->preview_player_rank++;

   240

				}

   241

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

   242

				PlayerID best_player = GetBestPlayer(e->preview_player_rank);

   243

   244

				if (best_player == PLAYER_SPECTATOR) {

   245

					e->preview_player_rank = 0xFF;

   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

CommandCost 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_rank) != _current_player) return CMD_ERROR;

   276

   277

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

   278

   279

	return CommandCost();

   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 (e->type == VEH_TRAIN) {

   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

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

   335

		/* maybe make another road type available */

   336

		FOR_ALL_PLAYERS(p) {

   337

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

   338

		}

   339

	}

   340

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

   341

}

   342

   343

void EnginesMonthlyLoop()

   344

{

   345

	if (_cur_year < YEAR_ENGINE_AGING_STOPS) {

   346

		Engine *e;

   347

		FOR_ALL_ENGINES(e) {

   348

			/* Age the vehicle */

   349

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

   350

				e->age++;

   351

				CalcEngineReliability(e);

   352

			}

   353

   354

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

   355

				/* Introduce it to all players */

   356

				NewVehicleAvailable(e);

   357

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

   358

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

   359

				e->flags |= ENGINE_EXCLUSIVE_PREVIEW;

   360

   361

				/* Do not introduce new rail wagons */

   362

				if (!IsWagon(e - _engines))

   363

					e->preview_player_rank = 1; // Give to the player with the highest rating.

   364

			}

   365

		}

   366

	}

   367

}

   368

   369

static bool IsUniqueEngineName(const char *name)

   370

{

   371

	char buf[512];

   372

   373

	for (EngineID i = 0; i < TOTAL_NUM_ENGINES; i++) {

   374

		SetDParam(0, i);

   375

		GetString(buf, STR_ENGINE_NAME, lastof(buf));

   376

		if (strcmp(buf, name) == 0) return false;

   377

	}

   378

   379

	return true;

   380

}

   381

   382

/** Rename an engine.

   383

 * @param tile unused

   384

 * @param flags operation to perfom

   385

 * @param p1 engine ID to rename

   386

 * @param p2 unused

   387

 */

   388

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

   389

{

   390

	if (!IsEngineIndex(p1) || StrEmpty(_cmd_text)) return CMD_ERROR;

   391

   392

	if (!IsUniqueEngineName(_cmd_text)) return_cmd_error(STR_NAME_MUST_BE_UNIQUE);

   393

   394

	if (flags & DC_EXEC) {

   395

		Engine *e = GetEngine(p1);

   396

		free(e->name);

   397

		e->name = strdup(_cmd_text);

   398

		_vehicle_design_names |= 3;

   399

		MarkWholeScreenDirty();

   400

	}

   401

   402

	return CommandCost();

   403

}

   404

   405

   406

/** Check if an engine is buildable.

   407

 * @param engine index of the engine to check.

   408

 * @param type   the type the engine should be.

   409

 * @param player index of the player.

   410

 * @return True if an engine is valid, of the specified type, and buildable by

   411

 *              the given player.

   412

 */

   413

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

   414

{

   415

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

   416

	if (!IsEngineIndex(engine)) return false;

   417

   418

	const Engine *e = GetEngine(engine);

   419

   420

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

   421

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

   422

   423

	/* check if it's available */

   424

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

   425

   426

	if (type == VEH_TRAIN) {

   427

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

   428

		const Player *p = GetPlayer(player);

   429

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

   430

	}

   431

   432

	return true;

   433

}

   434

   435

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

   436

 * @param engine The ID to get the cargo for

   437

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

   438

 */

   439

CargoID GetEngineCargoType(EngineID engine)

   440

{

   441

	assert(IsEngineIndex(engine));

   442

   443

	switch (GetEngine(engine)->type) {

   444

		case VEH_TRAIN:

   445

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

   446

			return RailVehInfo(engine)->cargo_type;

   447

   448

		case VEH_ROAD:

   449

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

   450

			return RoadVehInfo(engine)->cargo_type;

   451

   452

		case VEH_SHIP:

   453

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

   454

			return ShipVehInfo(engine)->cargo_type;

   455

   456

		case VEH_AIRCRAFT:

   457

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

   458

			return CT_PASSENGERS;

   459

   460

		default: NOT_REACHED(); return CT_INVALID;

   461

	}

   462

}

   463

   464

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

   465

 * Engine Replacement stuff

   466

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

   467

   468

DEFINE_OLD_POOL_GENERIC(EngineRenew, EngineRenew)

   469

   470

/**

   471

 * Retrieves the EngineRenew that specifies the replacement of the given

   472

 * engine type from the given renewlist */

   473

static EngineRenew *GetEngineReplacement(EngineRenewList erl, EngineID engine, GroupID group)

   474

{

   475

	EngineRenew *er = (EngineRenew *)erl;

   476

   477

	while (er) {

   478

		if (er->from == engine && er->group_id == group) return er;

   479

		er = er->next;

   480

	}

   481

	return NULL;

   482

}

   483

   484

void RemoveAllEngineReplacement(EngineRenewList *erl)

   485

{

   486

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

   487

	EngineRenew *next;

   488