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

    31

#include <map>

    32

    33

#include "table/strings.h"

    34

#include "table/engines.h"

    35

    36

DEFINE_OLD_POOL_GENERIC(Engine, Engine)

    37

    38

enum {

    39

	YEAR_ENGINE_AGING_STOPS = 2050,

    40

};

    41

    42

    43

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

    44

const uint8 _engine_counts[4] = {

    45

	lengthof(_orig_rail_vehicle_info),

    46

	lengthof(_orig_road_vehicle_info),

    47

	lengthof(_orig_ship_vehicle_info),

    48

	lengthof(_orig_aircraft_vehicle_info),

    49

};

    50

    51

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

    52

const uint8 _engine_offsets[4] = {

    53

	0,

    54

	lengthof(_orig_rail_vehicle_info),

    55

	lengthof(_orig_rail_vehicle_info) + lengthof(_orig_road_vehicle_info),

    56

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

    57

};

    58

    59

Engine::Engine() :

    60

	name(NULL),

    61

	overrides_count(0),

    62

	overrides(NULL)

    63

{

    64

}

    65

    66

Engine::Engine(VehicleType type, EngineID base)

    67

{

    68

	this->type = type;

    69

	this->internal_id = base;

    70

	this->list_position = base;

    71

    72

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

    73

	if (base >= _engine_counts[type]) {

    74

		/* Mark engine as valid anyway */

    75

		this->info.climates = 0x80;

    76

		return;

    77

	}

    78

    79

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

    80

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

    81

    82

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

    83

	switch (type) {

    84

		default: NOT_REACHED();

    85

    86

		case VEH_TRAIN:

    87

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

    88

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

    89

			this->info.string_id = STR_8000_KIRBY_PAUL_TANK_STEAM + base;

    90

			break;

    91

    92

		case VEH_ROAD:

    93

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

    94

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

    95

			this->info.string_id = STR_8074_MPS_REGAL_BUS + base;

    96

			break;

    97

    98

		case VEH_SHIP:

    99

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

   100

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

   101

			this->info.string_id = STR_80CC_MPS_OIL_TANKER + base;

   102

			break;

   103

   104

		case VEH_AIRCRAFT:

   105

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

   106

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

   107

			this->info.string_id = STR_80D7_SAMPSON_U52 + base;

   108

			break;

   109

	}

   110

}

   111

   112

Engine::~Engine()

   113

{

   114

	UnloadWagonOverrides(this);

   115

	free(this->name);

   116

}

   117

   118

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

   119

 */

   120

void SetCachedEngineCounts()

   121

{

   122

	uint engines = GetEnginePoolSize();

   123

   124

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

   125

	Player *p;

   126

	FOR_ALL_PLAYERS(p) {

   127

		free(p->num_engines);

   128

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

   129

	}

   130

   131

	/* Recalculate */

   132

	Group *g;

   133

	FOR_ALL_GROUPS(g) {

   134

		free(g->num_engines);

   135

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

   136

	}

   137

   138

	const Vehicle *v;

   139

	FOR_ALL_VEHICLES(v) {

   140

		if (!IsEngineCountable(v)) continue;

   141

   142

		assert(v->engine_type < engines);

   143

   144

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

   145

   146

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

   147

   148

		g = GetGroup(v->group_id);

   149

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

   150

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

   151

   152

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

   153

	}

   154

}

   155

   156

void SetupEngines()

   157

{

   158

	_Engine_pool.CleanPool();

   159

	_Engine_pool.AddBlockToPool();

   160

   161

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

   162

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

   163

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

   164

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

   165

}

   166

   167

   168

void ShowEnginePreviewWindow(EngineID engine);

   169

   170

void DeleteCustomEngineNames()

   171

{

   172

	Engine *e;

   173

	FOR_ALL_ENGINES(e) {

   174

		free(e->name);

   175

		e->name = NULL;

   176

	}

   177

   178

	_vehicle_design_names &= ~1;

   179

}

   180

   181

void LoadCustomEngineNames()

   182

{

   183

	/* XXX: not done */

   184

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

   185

}

   186

   187

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

   188

static bool IsWagon(EngineID index)

   189

{

   190

	const Engine *e = GetEngine(index);

   191

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

   192

}

   193

   194

static void CalcEngineReliability(Engine *e)

   195

{

   196

	uint age = e->age;

   197

   198

	/* Check for early retirement */

   199

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

   200

		int retire_early = e->info.retire_early;

   201

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

   202

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

   203

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

   204

			e->player_avail = 0;

   205

			AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   206

		}

   207

	}

   208

   209

	if (age < e->duration_phase_1) {

   210

		uint start = e->reliability_start;

   211

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

   212

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

   213

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

   214

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

   215

		e->reliability = e->reliability_max;

   216

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

   217

		uint max = e->reliability_max;

   218

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

   219

	} else {

   220

		/* time's up for this engine.

   221

		 * We will now completely retire this design */

   222

		e->player_avail = 0;

   223

		e->reliability = e->reliability_final;

   224

		/* Kick this engine out of the lists */

   225

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   226

	}

   227

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

   228

	InvalidateWindowClasses(WC_REPLACE_VEHICLE);

   229

}

   230

   231

void StartupEngines()

   232

{

   233

	Engine *e;

   234

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

   235

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

   236

   237

	FOR_ALL_ENGINES(e) {

   238

		const EngineInfo *ei = &e->info;

   239

		uint32 r;

   240

   241

		e->age = 0;

   242

		e->flags = 0;

   243

		e->player_avail = 0;

   244

   245

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

   246

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

   247

		 * added. */

   248

		r = Random();

   249

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

   250

		if (e->intro_date <= _date) {

   251

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

   252

			e->player_avail = (byte)-1;

   253

			e->flags |= ENGINE_AVAILABLE;

   254

		}

   255

   256

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

   257

		r = Random();

   258

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

   259

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

   260

   261

		r = Random();

   262

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

   263

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

   264

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

   265

   266

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

   267

   268

		if (IsWagon(e->index)) {

   269

			e->age = 0xFFFF;

   270

		} else {

   271

			CalcEngineReliability(e);

   272

		}

   273

   274

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

   275

   276

		/* prevent certain engines from ever appearing. */

   277

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

   278

			e->flags |= ENGINE_AVAILABLE;

   279

			e->player_avail = 0;

   280

		}

   281

	}

   282

}

   283

   284

static void AcceptEnginePreview(EngineID eid, PlayerID player)

   285

{

   286

	Engine *e = GetEngine(eid);

   287

	Player *p = GetPlayer(player);

   288

   289

	SetBit(e->player_avail, player);

   290

	if (e->type == VEH_TRAIN) {

   291

		const RailVehicleInfo *rvi = RailVehInfo(eid);

   292

   293

		assert(rvi->railtype < RAILTYPE_END);

   294

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

   295

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

   296

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

   297

	}

   298

   299

	e->preview_player_rank = 0xFF;

   300

	if (player == _local_player) {

   301

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   302

	}

   303

}

   304

   305

static PlayerID GetBestPlayer(uint8 pp)

   306

{

   307

	const Player *p;

   308

	int32 best_hist;

   309

	PlayerID best_player;

   310

	uint mask = 0;

   311

   312

	do {

   313

		best_hist = -1;

   314

		best_player = PLAYER_SPECTATOR;

   315

		FOR_ALL_PLAYERS(p) {

   316

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

   317

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

   318

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

   319

				best_player = p->index;

   320

			}

   321

		}

   322

   323

		if (best_player == PLAYER_SPECTATOR) return PLAYER_SPECTATOR;

   324

   325

		SetBit(mask, best_player);

   326

	} while (--pp != 0);

   327

   328

	return best_player;

   329

}

   330

   331

void EnginesDailyLoop()

   332

{

   333

	if (_cur_year >= YEAR_ENGINE_AGING_STOPS) return;

   334

   335

	Engine *e;

   336

	FOR_ALL_ENGINES(e) {

   337

		EngineID i = e->index;

   338

		if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   339

			if (e->flags & ENGINE_OFFER_WINDOW_OPEN) {

   340

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

   341

					e->flags &= ~ENGINE_OFFER_WINDOW_OPEN;

   342

					DeleteWindowById(WC_ENGINE_PREVIEW, i);

   343

					e->preview_player_rank++;

   344

				}

   345

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

   346

				PlayerID best_player = GetBestPlayer(e->preview_player_rank);

   347

   348

				if (best_player == PLAYER_SPECTATOR) {

   349

					e->preview_player_rank = 0xFF;

   350

					continue;

   351

				}

   352

   353

				if (!IsHumanPlayer(best_player)) {

   354

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

   355

					AcceptEnginePreview(i, best_player);

   356

				} else {

   357

					e->flags |= ENGINE_OFFER_WINDOW_OPEN;

   358

					e->preview_wait = 20;

   359

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

   360

				}

   361

			}

   362

		}

   363

	}

   364

}

   365

   366

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

   367

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

   368

 * @param tile unused

   369

 * @param flags operation to perfom

   370

 * @param p1 engine-prototype offered

   371

 * @param p2 unused

   372

 */

   373

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

   374

{

   375

	Engine *e;

   376

   377

	if (!IsEngineIndex(p1)) return CMD_ERROR;

   378

	e = GetEngine(p1);

   379

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

   380

   381

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

   382

   383

	return CommandCost();

   384

}

   385

   386

StringID GetEngineCategoryName(EngineID engine);

   387

   388

static void NewVehicleAvailable(Engine *e)

   389

{

   390

	Vehicle *v;

   391

	Player *p;

   392

	EngineID index = e->index;

   393

   394

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

   395

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

   396

	if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   397

		FOR_ALL_PLAYERS(p) {

   398

			uint block_preview = p->block_preview;

   399

   400

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

   401

   402

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

   403

			p->block_preview = 20;

   404

   405

			FOR_ALL_VEHICLES(v) {

   406

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

   407

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

   408

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

   409

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

   410

						p->block_preview = block_preview;

   411

						break;

   412

					}

   413

				}

   414

			}

   415

		}

   416

	}

   417

   418

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

   419

	AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   420

   421

	/* Now available for all players */

   422

	e->player_avail = (byte)-1;

   423

   424

	/* Do not introduce new rail wagons */

   425

	if (IsWagon(index)) return;

   426

   427

	if (e->type == VEH_TRAIN) {

   428

		/* maybe make another rail type available */

   429

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

   430

		assert(railtype < RAILTYPE_END);

   431

		FOR_ALL_PLAYERS(p) {

   432

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

   433

		}

   434

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

   435

		/* maybe make another road type available */

   436

		FOR_ALL_PLAYERS(p) {

   437

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

   438

		}

   439

	}

   440

   441

	SetDParam(0, GetEngineCategoryName(index));

   442

	SetDParam(1, index);

   443

	AddNewsItem(STR_NEW_VEHICLE_NOW_AVAILABLE_WITH_TYPE, NS_NEW_VEHICLES, index, 0);

   444

}

   445

   446

void EnginesMonthlyLoop()

   447

{

   448

	if (_cur_year < YEAR_ENGINE_AGING_STOPS) {

   449

		Engine *e;

   450

		FOR_ALL_ENGINES(e) {

   451

			/* Age the vehicle */

   452

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

   453

				e->age++;

   454

				CalcEngineReliability(e);

   455

			}

   456

   457

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

   458

				/* Introduce it to all players */

   459

				NewVehicleAvailable(e);

   460

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

   461

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

   462

				e->flags |= ENGINE_EXCLUSIVE_PREVIEW;

   463

   464

				/* Do not introduce new rail wagons */

   465

				if (!IsWagon(e->index))

   466

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

   467

			}

   468

		}

   469

	}

   470

}

   471

   472

static bool IsUniqueEngineName(const char *name)

   473

{

   474

	char buf[512];

   475

   476

	const Engine *e;

   477

	FOR_ALL_ENGINES(e) {

   478

		SetDParam(0, e->index);

   479

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

   480

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

   481

	}

   482

   483

	return true;

   484

}

   485

   486

/** Rename an engine.

   487

 * @param tile unused

   488

 * @param flags operation to perfom