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 "company_base.h"

     9

#include "company_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_gui.h"

    25

#include "string_func.h"

    26

#include "settings_type.h"

    27

#include "oldpool_func.h"

    28

#include "core/alloc_func.hpp"

    29

#include "vehicle_func.h"

    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

/** Sets cached values in Company::num_vehicles and Group::num_vehicles

   118

 */

   119

void SetCachedEngineCounts()

   120

{

   121

	uint engines = GetEnginePoolSize();

   122

   123

	/* Set up the engine count for all companies */

   124

	Company *c;

   125

	FOR_ALL_COMPANIES(c) {

   126

		free(c->num_engines);

   127

		c->num_engines = CallocT<EngineID>(engines);

   128

	}

   129

   130

	/* Recalculate */

   131

	Group *g;

   132

	FOR_ALL_GROUPS(g) {

   133

		free(g->num_engines);

   134

		g->num_engines = CallocT<EngineID>(engines);

   135

	}

   136

   137

	const Vehicle *v;

   138

	FOR_ALL_VEHICLES(v) {

   139

		if (!IsEngineCountable(v)) continue;

   140

   141

		assert(v->engine_type < engines);

   142

   143

		GetCompany(v->owner)->num_engines[v->engine_type]++;

   144

   145

		if (v->group_id == DEFAULT_GROUP) continue;

   146

   147

		g = GetGroup(v->group_id);

   148

		assert(v->type == g->vehicle_type);

   149

		assert(v->owner == g->owner);

   150

   151

		g->num_engines[v->engine_type]++;

   152

	}

   153

}

   154

   155

void SetupEngines()

   156

{

   157

	_Engine_pool.CleanPool();

   158

	_Engine_pool.AddBlockToPool();

   159

   160

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

   161

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

   162

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

   163

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

   164

}

   165

   166

   167

void ShowEnginePreviewWindow(EngineID engine);

   168

   169

void DeleteCustomEngineNames()

   170

{

   171

	Engine *e;

   172

	FOR_ALL_ENGINES(e) {

   173

		free(e->name);

   174

		e->name = NULL;

   175

	}

   176

   177

	_vehicle_design_names &= ~1;

   178

}

   179

   180

void LoadCustomEngineNames()

   181

{

   182

	/* XXX: not done */

   183

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

   184

}

   185

   186

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

   187

static bool IsWagon(EngineID index)

   188

{

   189

	const Engine *e = GetEngine(index);

   190

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

   191

}

   192

   193

static void CalcEngineReliability(Engine *e)

   194

{

   195

	uint age = e->age;

   196

   197

	/* Check for early retirement */

   198

	if (e->company_avail != 0 && !_settings_game.vehicle.never_expire_vehicles) {

   199

		int retire_early = e->info.retire_early;

   200

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

   201

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

   202

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

   203

			e->company_avail = 0;

   204

			AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   205

		}

   206

	}

   207

   208

	if (age < e->duration_phase_1) {

   209

		uint start = e->reliability_start;

   210

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

   211

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

   212

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

   213

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

   214

		e->reliability = e->reliability_max;

   215

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

   216

		uint max = e->reliability_max;

   217

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

   218

	} else {

   219

		/* time's up for this engine.

   220

		 * We will now completely retire this design */

   221

		e->company_avail = 0;

   222

		e->reliability = e->reliability_final;

   223

		/* Kick this engine out of the lists */

   224

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   225

	}

   226

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

   227

	InvalidateWindowClasses(WC_REPLACE_VEHICLE);

   228

}

   229

   230

void StartupEngines()

   231

{

   232

	Engine *e;

   233

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

   234

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

   235

   236

	FOR_ALL_ENGINES(e) {

   237

		const EngineInfo *ei = &e->info;

   238

		uint32 r;

   239

   240

		e->age = 0;

   241

		e->flags = 0;

   242

		e->company_avail = 0;

   243

   244

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

   245

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

   246

		 * added. */

   247

		r = Random();

   248

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

   249

		if (e->intro_date <= _date) {

   250

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

   251

			e->company_avail = (CompanyMask)-1;

   252

			e->flags |= ENGINE_AVAILABLE;

   253

		}

   254

   255

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

   256

		r = Random();

   257

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

   258

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

   259

   260

		r = Random();

   261

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

   262

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

   263

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

   264

   265

		e->reliability_spd_dec = ei->decay_speed << 2;

   266

   267

		if (IsWagon(e->index)) {

   268

			e->age = 0xFFFF;

   269

		} else {

   270

			CalcEngineReliability(e);

   271

		}

   272

   273

		e->lifelength = ei->lifelength + _settings_game.vehicle.extend_vehicle_life;

   274

   275

		/* prevent certain engines from ever appearing. */

   276

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

   277

			e->flags |= ENGINE_AVAILABLE;

   278

			e->company_avail = 0;

   279

		}

   280

	}

   281

   282

	/* Update the bitmasks for the vehicle lists */

   283

	Company *c;

   284

	FOR_ALL_COMPANIES(c) {

   285

		c->avail_railtypes = GetCompanyRailtypes(c->index);

   286

		c->avail_roadtypes = GetCompanyRoadtypes(c->index);

   287

	}

   288

}

   289

   290

static void AcceptEnginePreview(EngineID eid, CompanyID company)

   291

{

   292

	Engine *e = GetEngine(eid);

   293

	Company *c = GetCompany(company);

   294

   295

	SetBit(e->company_avail, company);

   296

	if (e->type == VEH_TRAIN) {

   297

		const RailVehicleInfo *rvi = RailVehInfo(eid);

   298

   299

		assert(rvi->railtype < RAILTYPE_END);

   300

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

   301

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

   302

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

   303

	}

   304

   305

	e->preview_company_rank = 0xFF;

   306

	if (company == _local_company) {

   307

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   308

	}

   309

}

   310

   311

static CompanyID GetBestCompany(uint8 pp)

   312

{

   313

	const Company *c;

   314

	int32 best_hist;

   315

	CompanyID best_company;

   316

	uint mask = 0;

   317

   318

	do {

   319

		best_hist = -1;

   320

		best_company = INVALID_COMPANY;

   321

		FOR_ALL_COMPANIES(c) {

   322

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

   323

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

   324

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

   325

				best_company = c->index;

   326

			}

   327

		}

   328

   329

		if (best_company == INVALID_COMPANY) return INVALID_COMPANY;

   330

   331

		SetBit(mask, best_company);

   332

	} while (--pp != 0);

   333

   334

	return best_company;

   335

}

   336

   337

void EnginesDailyLoop()

   338

{

   339

	if (_cur_year >= YEAR_ENGINE_AGING_STOPS) return;

   340

   341

	Engine *e;

   342

	FOR_ALL_ENGINES(e) {

   343

		EngineID i = e->index;

   344

		if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   345

			if (e->flags & ENGINE_OFFER_WINDOW_OPEN) {

   346

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

   347

					e->flags &= ~ENGINE_OFFER_WINDOW_OPEN;

   348

					DeleteWindowById(WC_ENGINE_PREVIEW, i);

   349

					e->preview_company_rank++;

   350

				}

   351

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

   352

				CompanyID best_company = GetBestCompany(e->preview_company_rank);

   353

   354

				if (best_company == INVALID_COMPANY) {

   355

					e->preview_company_rank = 0xFF;

   356

					continue;

   357

				}

   358

   359

				if (!IsHumanCompany(best_company)) {

   360

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

   361

					AcceptEnginePreview(i, best_company);

   362

				} else {

   363

					e->flags |= ENGINE_OFFER_WINDOW_OPEN;

   364

					e->preview_wait = 20;

   365

					if (IsInteractiveCompany(best_company)) ShowEnginePreviewWindow(i);

   366

				}

   367

			}

   368

		}

   369

	}

   370

}

   371

   372

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

   373

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

   374

 * @param tile unused

   375

 * @param flags operation to perfom

   376

 * @param p1 engine-prototype offered

   377

 * @param p2 unused

   378

 */

   379

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

   380

{

   381

	Engine *e;

   382

   383

	if (!IsEngineIndex(p1)) return CMD_ERROR;

   384

	e = GetEngine(p1);

   385

	if (GetBestCompany(e->preview_company_rank) != _current_company) return CMD_ERROR;

   386

   387

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

   388

   389

	return CommandCost();

   390

}

   391

   392

StringID GetEngineCategoryName(EngineID engine);

   393

   394

static void NewVehicleAvailable(Engine *e)

   395

{

   396

	Vehicle *v;

   397

	Company *c;

   398

	EngineID index = e->index;

   399

   400

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

   401

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

   402

	if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   403

		FOR_ALL_COMPANIES(c) {

   404

			uint block_preview = c->block_preview;

   405

   406

			if (!HasBit(e->company_avail, c->index)) continue;

   407

   408

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

   409

			c->block_preview = 20;

   410

   411

			FOR_ALL_VEHICLES(v) {

   412

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

   413

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

   414

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

   415

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

   416

						c->block_preview = block_preview;

   417

						break;

   418

					}

   419

				}

   420

			}

   421

		}

   422

	}

   423

   424

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

   425

	AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   426

   427

	/* Now available for all companies */

   428

	e->company_avail = (CompanyMask)-1;

   429

   430

	/* Do not introduce new rail wagons */

   431

	if (IsWagon(index)) return;

   432

   433

	if (e->type == VEH_TRAIN) {

   434

		/* maybe make another rail type available */

   435

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

   436

		assert(railtype < RAILTYPE_END);

   437

		FOR_ALL_COMPANIES(c) SetBit(c->avail_railtypes, railtype);

   438

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

   439

		/* maybe make another road type available */

   440

		FOR_ALL_COMPANIES(c) SetBit(c->avail_roadtypes, HasBit(e->info.misc_flags, EF_ROAD_TRAM) ? ROADTYPE_TRAM : ROADTYPE_ROAD);

   441

	}

   442

   443

	SetDParam(0, GetEngineCategoryName(index));

   444

	SetDParam(1, index);

   445

	AddNewsItem(STR_NEW_VEHICLE_NOW_AVAILABLE_WITH_TYPE, NS_NEW_VEHICLES, index, 0);

   446

}

   447

   448

void EnginesMonthlyLoop()

   449

{

   450

	if (_cur_year < YEAR_ENGINE_AGING_STOPS) {

   451

		Engine *e;

   452

		FOR_ALL_ENGINES(e) {

   453

			/* Age the vehicle */

   454

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

   455

				e->age++;

   456

				CalcEngineReliability(e);

   457

			}

   458

   459

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

   460

				/* Introduce it to all companies */

   461

				NewVehicleAvailable(e);

   462

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

   463

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

   464

				e->flags |= ENGINE_EXCLUSIVE_PREVIEW;

   465

   466

				/* Do not introduce new rail wagons */

   467

				if (!IsWagon(e->index))

   468

					e->preview_company_rank = 1; // Give to the company with the highest rating.

   469

			}

   470

		}

   471

	}

   472

}

   473

   474

static bool IsUniqueEngineName(const char *name)

   475

{

   476

	char buf[512];

   477

   478

	const Engine *e;

   479

	FOR_ALL_ENGINES(e) {

   480

		SetDParam(0, e->index);

   481

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

   482

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

   483

	}

   484

   485

	return true;

   486

}

   487