1

/* $Id$ */

     2

     3

/** @file engine.cpp Base for all engine handling. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "player_base.h"

     9

#include "player_func.h"

    10

#include "command_func.h"

    11

#include "news_func.h"

    12

#include "saveload.h"

    13

#include "variables.h"

    14

#include "train.h"

    15

#include "aircraft.h"

    16

#include "newgrf_cargo.h"

    17

#include "newgrf_engine.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

#include "oldpool_func.h"

    29

#include "core/alloc_func.hpp"

    30

#include "map"

    31

    32

#include "table/strings.h"

    33

#include "table/engines.h"

    34

    35

DEFINE_OLD_POOL_GENERIC(Engine, Engine)

    36

    37

enum {

    38

	YEAR_ENGINE_AGING_STOPS = 2050,

    39

};

    40

    41

    42

/** Number of engines of each vehicle type in original engine data */

    43

const uint8 _engine_counts[4] = {

    44

	lengthof(_orig_rail_vehicle_info),

    45

	lengthof(_orig_road_vehicle_info),

    46

	lengthof(_orig_ship_vehicle_info),

    47

	lengthof(_orig_aircraft_vehicle_info),

    48

};

    49

    50

/** Offset of the first engine of each vehicle type in original engine data */

    51

const uint8 _engine_offsets[4] = {

    52

	0,

    53

	lengthof(_orig_rail_vehicle_info),

    54

	lengthof(_orig_rail_vehicle_info) + lengthof(_orig_road_vehicle_info),

    55

	lengthof(_orig_rail_vehicle_info) + lengthof(_orig_road_vehicle_info) + lengthof(_orig_ship_vehicle_info),

    56

};

    57

    58

Engine::Engine() :

    59

	name(NULL),

    60

	overrides_count(0),

    61

	overrides(NULL)

    62

{

    63

}

    64

    65

Engine::Engine(VehicleType type, EngineID base)

    66

{

    67

	this->type = type;

    68

	this->internal_id = base;

    69

	this->list_position = base;

    70

    71

	/* Check if this base engine is within the original engine data range */

    72

	if (base >= _engine_counts[type]) {

    73

		/* Mark engine as valid anyway */

    74

		this->info.climates = 0x80;

    75

		return;

    76

	}

    77

    78

	/* Copy the original engine info for this slot */

    79

	this->info = _orig_engine_info[_engine_offsets[type] + base];

    80

    81

	/* Copy the original engine data for this slot */

    82

	switch (type) {

    83

		default: NOT_REACHED();

    84

    85

		case VEH_TRAIN:

    86

			this->u.rail = _orig_rail_vehicle_info[base];

    87

			this->image_index = this->u.rail.image_index;

    88

			this->info.string_id = STR_8000_KIRBY_PAUL_TANK_STEAM + base;

    89

			break;

    90

    91

		case VEH_ROAD:

    92

			this->u.road = _orig_road_vehicle_info[base];

    93

			this->image_index = this->u.road.image_index;

    94

			this->info.string_id = STR_8074_MPS_REGAL_BUS + base;

    95

			break;

    96

    97

		case VEH_SHIP:

    98

			this->u.ship = _orig_ship_vehicle_info[base];

    99

			this->image_index = this->u.ship.image_index;

   100

			this->info.string_id = STR_80CC_MPS_OIL_TANKER + base;

   101

			break;

   102

   103

		case VEH_AIRCRAFT:

   104

			this->u.air = _orig_aircraft_vehicle_info[base];

   105

			this->image_index = this->u.air.image_index;

   106

			this->info.string_id = STR_80D7_SAMPSON_U52 + base;

   107

			break;

   108

	}

   109

}

   110

   111

Engine::~Engine()

   112

{

   113

	UnloadWagonOverrides(this);

   114

	free(this->name);

   115

}

   116

   117

/** Sort all items using qsort() and given 'CompareItems' function

   118

 * @param el list to be sorted

   119

 * @param compare function for evaluation of the quicksort

   120

 */

   121

void EngList_Sort(EngineList *el, EngList_SortTypeFunction compare)

   122

{

   128

}

   129

   130

/** Sort selected range of items (on indices @ <begin, begin+num_items-1>)

   131

 * @param el list to be sorted

   132

 * @param compare function for evaluation of the quicksort

   133

 * @param begin start of sorting

   134

 * @param num_items count of items to be sorted

   135

 */

   136

void EngList_SortPartial(EngineList *el, EngList_SortTypeFunction compare, uint begin, uint num_items)

   137

{

   138

	assert(begin <= (uint)el->size());

   139

	assert(begin + num_items <= (uint)el->size());

   140

	qsort(&((*el)[begin]), num_items, sizeof(EngineID), compare);

   141

}

   142

   143

void SetupEngines()

   144

{

   145

	_Engine_pool.CleanPool();

   146

	_Engine_pool.AddBlockToPool();

   147

   148

	for (uint i = 0; i < lengthof(_orig_rail_vehicle_info); i++) new Engine(VEH_TRAIN, i);

   149

	for (uint i = 0; i < lengthof(_orig_road_vehicle_info); i++) new Engine(VEH_ROAD, i);

   150

	for (uint i = 0; i < lengthof(_orig_ship_vehicle_info); i++) new Engine(VEH_SHIP, i);

   151

	for (uint i = 0; i < lengthof(_orig_aircraft_vehicle_info); i++) new Engine(VEH_AIRCRAFT, i);

   152

}

   153

   154

   155

void ShowEnginePreviewWindow(EngineID engine);

   156

   157

void DeleteCustomEngineNames()

   158

{

   159

	Engine *e;

   160

	FOR_ALL_ENGINES(e) {

   161

		free(e->name);

   162

		e->name = NULL;

   163

	}

   164

   165

	_vehicle_design_names &= ~1;

   166

}

   167

   168

void LoadCustomEngineNames()

   169

{

   170

	/* XXX: not done */

   171

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

   172

}

   173

   174

static void CalcEngineReliability(Engine *e)

   175

{

   176

	uint age = e->age;

   177

   178

	/* Check for early retirement */

   179

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

   180

		int retire_early = e->info.retire_early;

   181

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

   182

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

   183

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

   184

			e->player_avail = 0;

   185

			AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   186

		}

   187

	}

   188

   189

	if (age < e->duration_phase_1) {

   190

		uint start = e->reliability_start;

   191

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

   192

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

   193

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

   194

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

   195

		e->reliability = e->reliability_max;

   196

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

   197

		uint max = e->reliability_max;

   198

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

   199

	} else {

   200

		/* time's up for this engine.

   201

		 * We will now completely retire this design */

   202

		e->player_avail = 0;

   203

		e->reliability = e->reliability_final;

   204

		/* Kick this engine out of the lists */

   205

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   206

	}

   207

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

   208

	InvalidateWindowClasses(WC_REPLACE_VEHICLE);

   209

}

   210

   211

void StartupEngines()

   212

{

   213

	Engine *e;

   214

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

   215

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

   216

   217

	FOR_ALL_ENGINES(e) {

   218

		const EngineInfo *ei = &e->info;

   219

		uint32 r;

   220

   221

		e->age = 0;

   222

		e->flags = 0;

   223

		e->player_avail = 0;

   224

   225

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

   226

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

   227

		 * added. */

   228

		r = Random();

   229

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

   230

		if (e->intro_date <= _date) {

   231

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

   232

			e->player_avail = (byte)-1;

   233

			e->flags |= ENGINE_AVAILABLE;

   234

		}

   235

   236

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

   237

		r = Random();

   238

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

   239

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

   240

   241

		r = Random();

   242

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

   243

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

   244

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

   245

   246

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

   247

   248

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

   249

		if (ei->unk2 & 0x80) {

   250

			e->age = 0xFFFF;

   251

		} else {

   252

			CalcEngineReliability(e);

   253

		}

   254

   255

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

   256

   257

		/* prevent certain engines from ever appearing. */

   258

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

   259

			e->flags |= ENGINE_AVAILABLE;

   260

			e->player_avail = 0;

   261

		}

   262

	}

   263

}

   264

   265

static void AcceptEnginePreview(EngineID eid, PlayerID player)

   266

{

   267

	Engine *e = GetEngine(eid);

   268

	Player *p = GetPlayer(player);

   269

   270

	SetBit(e->player_avail, player);

   271

	if (e->type == VEH_TRAIN) {

   272

		const RailVehicleInfo *rvi = RailVehInfo(eid);

   273

   274

		assert(rvi->railtype < RAILTYPE_END);

   275

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

   276

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

   277

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

   278

	}

   279

   280

	e->preview_player_rank = 0xFF;

   281

	if (player == _local_player) {

   282

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   283

	}

   284

}

   285

   286

static PlayerID GetBestPlayer(uint8 pp)

   287

{

   288

	const Player *p;

   289

	int32 best_hist;

   290

	PlayerID best_player;

   291

	uint mask = 0;

   292

   293

	do {

   294

		best_hist = -1;

   295

		best_player = PLAYER_SPECTATOR;

   296

		FOR_ALL_PLAYERS(p) {

   297

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

   298

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

   299

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

   300

				best_player = p->index;

   301

			}

   302

		}

   303

   304

		if (best_player == PLAYER_SPECTATOR) return PLAYER_SPECTATOR;

   305

   306

		SetBit(mask, best_player);

   307

	} while (--pp != 0);

   308

   309

	return best_player;

   310

}

   311

   312

void EnginesDailyLoop()

   313

{

   314

	if (_cur_year >= YEAR_ENGINE_AGING_STOPS) return;

   315

   316

	Engine *e;

   317

	FOR_ALL_ENGINES(e) {

   318

		EngineID i = e->index;

   319

		if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   320

			if (e->flags & ENGINE_OFFER_WINDOW_OPEN) {

   321

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

   322

					e->flags &= ~ENGINE_OFFER_WINDOW_OPEN;

   323

					DeleteWindowById(WC_ENGINE_PREVIEW, i);

   324

					e->preview_player_rank++;

   325

				}

   326

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

   327

				PlayerID best_player = GetBestPlayer(e->preview_player_rank);

   328

   329

				if (best_player == PLAYER_SPECTATOR) {

   330

					e->preview_player_rank = 0xFF;

   331

					continue;

   332

				}

   333

   334

				if (!IsHumanPlayer(best_player)) {

   335

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

   336

					AcceptEnginePreview(i, best_player);

   337

				} else {

   338

					e->flags |= ENGINE_OFFER_WINDOW_OPEN;

   339

					e->preview_wait = 20;

   340

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

   341

				}

   342

			}

   343

		}

   344

	}

   345

}

   346

   347

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

   348

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

   349

 * @param tile unused

   350

 * @param flags operation to perfom

   351

 * @param p1 engine-prototype offered

   352

 * @param p2 unused

   353

 */

   354

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

   355

{

   356

	Engine *e;

   357

   358

	if (!IsEngineIndex(p1)) return CMD_ERROR;

   359

	e = GetEngine(p1);

   360

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

   361

   362

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

   363

   364

	return CommandCost();

   365

}

   366

   367

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

   368

static bool IsWagon(EngineID index)

   369

{

   370

	const Engine *e = GetEngine(index);

   371

	return e->type == VEH_TRAIN && e->u.rail.railveh_type == RAILVEH_WAGON;

   372

}

   373

   374

StringID GetEngineCategoryName(EngineID engine);

   375

   376

static void NewVehicleAvailable(Engine *e)

   377

{

   378

	Vehicle *v;

   379

	Player *p;

   380

	EngineID index = e->index;

   381

   382

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

   383

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

   384

	if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   385

		FOR_ALL_PLAYERS(p) {

   386

			uint block_preview = p->block_preview;

   387

   388

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

   389

   390

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

   391

			p->block_preview = 20;

   392

   393

			FOR_ALL_VEHICLES(v) {

   394

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

   395

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

   396

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

   397

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

   398

						p->block_preview = block_preview;

   399

						break;

   400

					}

   401

				}

   402

			}

   403

		}

   404

	}

   405

   406

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

   407

	AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   408

   409

	/* Now available for all players */

   410

	e->player_avail = (byte)-1;

   411

   412

	/* Do not introduce new rail wagons */

   413

	if (IsWagon(index)) return;

   414

   415

	if (e->type == VEH_TRAIN) {

   416

		/* maybe make another rail type available */

   417

		RailType railtype = e->u.rail.railtype;

   418

		assert(railtype < RAILTYPE_END);

   419

		FOR_ALL_PLAYERS(p) {

   420

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

   421

		}

   422

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

   423

		/* maybe make another road type available */

   424

		FOR_ALL_PLAYERS(p) {

   425

			if (p->is_active) SetBit(p->avail_roadtypes, HasBit(e->info.misc_flags, EF_ROAD_TRAM) ? ROADTYPE_TRAM : ROADTYPE_ROAD);

   426

		}

   427

	}

   428

   429

	SetDParam(0, GetEngineCategoryName(index));

   430

	SetDParam(1, index);

   431

	AddNewsItem(STR_NEW_VEHICLE_NOW_AVAILABLE_WITH_TYPE, NM_CALLBACK, NF_NONE, NT_NEW_VEHICLES, DNC_VEHICLEAVAIL, index, 0);

   432

}

   433

   434

void EnginesMonthlyLoop()

   435

{

   436

	if (_cur_year < YEAR_ENGINE_AGING_STOPS) {

   437

		Engine *e;

   438

		FOR_ALL_ENGINES(e) {

   439

			/* Age the vehicle */

   440

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

   441

				e->age++;

   442

				CalcEngineReliability(e);

   443

			}

   444

   445

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

   446

				/* Introduce it to all players */

   447

				NewVehicleAvailable(e);

   448

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

   449

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

   450

				e->flags |= ENGINE_EXCLUSIVE_PREVIEW;

   451

   452

				/* Do not introduce new rail wagons */

   453

				if (!IsWagon(e->index))

   454

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

   455

			}

   456

		}

   457

	}

   458

}

   459

   460

static bool IsUniqueEngineName(const char *name)

   461

{

   462

	char buf[512];

   463

   464

	const Engine *e;

   465

	FOR_ALL_ENGINES(e) {

   466

		SetDParam(0, e->index);

   467

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

   468

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

   469

	}

   470

   471

	return true;

   472

}

   473

   474

/** Rename an engine.

   475

 * @param tile unused

   476

 * @param flags operation to perfom

   477

 * @param p1 engine ID to rename

   478

 * @param p2 unused

   479

 */

   480

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

   481

{

   482

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

   483

   484

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

   485

   486

	if (flags & DC_EXEC) {

   487

		Engine *e = GetEngine(p1);

   488

		free(e->name);

   489