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

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

   119

 * @param el list to be sorted

   120

 * @param compare function for evaluation of the quicksort

   121

 */

   122

void EngList_Sort(EngineList *el, EngList_SortTypeFunction compare)

   123

{

   124

	size_t size = el->size();

   125

	/* out-of-bounds access at the next line for size == 0 (even with operator[] at some systems)

   126

	 * generally, do not sort if there are less than 2 items */

   127

	if (size < 2) return;

   128

	qsort(&((*el)[0]), size, sizeof(EngineID), compare); // MorphOS doesn't know vector::at(int) ...

   129

}

   130

   131

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

   132

 * @param el list to be sorted

   133

 * @param compare function for evaluation of the quicksort

   134

 * @param begin start of sorting

   135

 * @param num_items count of items to be sorted

   136

 */

   137

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

   138

{

   139

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

   140

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

   141

	if (num_items < 2) return;

   142

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

   143

}

   144

   145

   146

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

   147

 */

   148

void SetCachedEngineCounts()

   149

{

   150

	uint engines = GetEnginePoolSize();

   151

   152

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

   153

	Player *p;

   154

	FOR_ALL_PLAYERS(p) {

   155

		free(p->num_engines);

   156

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

   157

	}

   158

   159

	/* Recalculate */

   160

	Group *g;

   161

	FOR_ALL_GROUPS(g) {

   162

		free(g->num_engines);

   163

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

   164

	}

   165

   166

	const Vehicle *v;

   167

	FOR_ALL_VEHICLES(v) {

   168

		if (!IsEngineCountable(v)) continue;

   169

   170

		assert(v->engine_type < engines);

   171

   172

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

   173

   174

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

   175

   176

		g = GetGroup(v->group_id);

   177

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

   178

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

   179

   180

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

   181

	}

   182

}

   183

   184

void SetupEngines()

   185

{

   186

	_Engine_pool.CleanPool();

   187

	_Engine_pool.AddBlockToPool();

   188

   189

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

   190

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

   191

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

   192

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

   193

}

   194

   195

   196

void ShowEnginePreviewWindow(EngineID engine);

   197

   198

void DeleteCustomEngineNames()

   199

{

   200

	Engine *e;

   201

	FOR_ALL_ENGINES(e) {

   202

		free(e->name);

   203

		e->name = NULL;

   204

	}

   205

   206

	_vehicle_design_names &= ~1;

   207

}

   208

   209

void LoadCustomEngineNames()

   210

{

   211

	/* XXX: not done */

   212

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

   213

}

   214

   215

static void CalcEngineReliability(Engine *e)

   216

{

   217

	uint age = e->age;

   218

   219

	/* Check for early retirement */

   220

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

   221

		int retire_early = e->info.retire_early;

   222

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

   223

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

   224

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

   225

			e->player_avail = 0;

   226

			AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   227

		}

   228

	}

   229

   230

	if (age < e->duration_phase_1) {

   231

		uint start = e->reliability_start;

   232

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

   233

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

   234

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

   235

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

   236

		e->reliability = e->reliability_max;

   237

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

   238

		uint max = e->reliability_max;

   239

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

   240

	} else {

   241

		/* time's up for this engine.

   242

		 * We will now completely retire this design */

   243

		e->player_avail = 0;

   244

		e->reliability = e->reliability_final;

   245

		/* Kick this engine out of the lists */

   246

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   247

	}

   248

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

   249

	InvalidateWindowClasses(WC_REPLACE_VEHICLE);

   250

}

   251

   252

void StartupEngines()

   253

{

   254

	Engine *e;

   255

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

   256

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

   257

   258

	FOR_ALL_ENGINES(e) {

   259

		const EngineInfo *ei = &e->info;

   260

		uint32 r;

   261

   262

		e->age = 0;

   263

		e->flags = 0;

   264

		e->player_avail = 0;

   265

   266

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

   267

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

   268

		 * added. */

   269

		r = Random();

   270

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

   271

		if (e->intro_date <= _date) {

   272

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

   273

			e->player_avail = (byte)-1;

   274

			e->flags |= ENGINE_AVAILABLE;

   275

		}

   276

   277

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

   278

		r = Random();

   279

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

   280

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

   281

   282

		r = Random();

   283

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

   284

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

   285

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

   286

   287

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

   288

   289

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

   290

		if (ei->unk2 & 0x80) {

   291

			e->age = 0xFFFF;

   292

		} else {

   293

			CalcEngineReliability(e);

   294

		}

   295

   296

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

   297

   298

		/* prevent certain engines from ever appearing. */

   300

			e->flags |= ENGINE_AVAILABLE;

   301

			e->player_avail = 0;

   302

		}

   303

	}

   304

}

   305

   306

static void AcceptEnginePreview(EngineID eid, PlayerID player)

   307

{

   308

	Engine *e = GetEngine(eid);

   309

	Player *p = GetPlayer(player);

   310

   311

	SetBit(e->player_avail, player);

   312

	if (e->type == VEH_TRAIN) {

   313

		const RailVehicleInfo *rvi = RailVehInfo(eid);

   314

   315

		assert(rvi->railtype < RAILTYPE_END);

   316

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

   317

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

   318

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

   319

	}

   320

   321

	e->preview_player_rank = 0xFF;

   322

	if (player == _local_player) {

   323

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   324

	}

   325

}

   326

   327

static PlayerID GetBestPlayer(uint8 pp)

   328

{

   329

	const Player *p;

   330

	int32 best_hist;

   331

	PlayerID best_player;

   332

	uint mask = 0;

   333

   334

	do {

   335

		best_hist = -1;

   336

		best_player = PLAYER_SPECTATOR;

   337

		FOR_ALL_PLAYERS(p) {

   338

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

   339

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

   340

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

   341

				best_player = p->index;

   342

			}

   343

		}

   344

   345

		if (best_player == PLAYER_SPECTATOR) return PLAYER_SPECTATOR;

   346

   347

		SetBit(mask, best_player);

   348

	} while (--pp != 0);

   349

   350

	return best_player;

   351

}

   352

   353

void EnginesDailyLoop()

   354

{

   355

	if (_cur_year >= YEAR_ENGINE_AGING_STOPS) return;

   356

   357

	Engine *e;

   358

	FOR_ALL_ENGINES(e) {

   359

		EngineID i = e->index;

   360

		if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   361

			if (e->flags & ENGINE_OFFER_WINDOW_OPEN) {

   362

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

   363

					e->flags &= ~ENGINE_OFFER_WINDOW_OPEN;

   364

					DeleteWindowById(WC_ENGINE_PREVIEW, i);

   365

					e->preview_player_rank++;

   366

				}

   367

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

   368

				PlayerID best_player = GetBestPlayer(e->preview_player_rank);

   369

   370

				if (best_player == PLAYER_SPECTATOR) {

   371

					e->preview_player_rank = 0xFF;

   372

					continue;

   373

				}

   374

   375

				if (!IsHumanPlayer(best_player)) {

   376

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

   377

					AcceptEnginePreview(i, best_player);

   378

				} else {

   379

					e->flags |= ENGINE_OFFER_WINDOW_OPEN;

   380

					e->preview_wait = 20;

   381

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

   382

				}

   383

			}

   384

		}

   385

	}

   386

}

   387

   388

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

   389

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

   390

 * @param tile unused

   391

 * @param flags operation to perfom

   392

 * @param p1 engine-prototype offered

   393

 * @param p2 unused

   394

 */

   395

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

   396

{

   397

	Engine *e;

   398

   399

	if (!IsEngineIndex(p1)) return CMD_ERROR;

   400

	e = GetEngine(p1);

   401

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

   402

   403

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

   404

   405

	return CommandCost();

   406

}

   407

   408

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

   409

static bool IsWagon(EngineID index)

   410

{

   411

	const Engine *e = GetEngine(index);

   412

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

   413

}

   414

   415

StringID GetEngineCategoryName(EngineID engine);

   416

   417

static void NewVehicleAvailable(Engine *e)

   418

{

   419

	Vehicle *v;

   420

	Player *p;

   421

	EngineID index = e->index;

   422

   423

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

   424

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

   425

	if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   426

		FOR_ALL_PLAYERS(p) {

   427

			uint block_preview = p->block_preview;

   428

   429

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

   430

   431

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

   432

			p->block_preview = 20;

   433

   434

			FOR_ALL_VEHICLES(v) {

   435

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

   436

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

   437

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

   438

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

   439

						p->block_preview = block_preview;

   440

						break;

   441

					}

   442

				}

   443

			}

   444

		}

   445

	}

   446

   447

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

   448

	AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   449

   450

	/* Now available for all players */

   451

	e->player_avail = (byte)-1;

   452

   453

	/* Do not introduce new rail wagons */

   454

	if (IsWagon(index)) return;

   455

   456

	if (e->type == VEH_TRAIN) {

   457

		/* maybe make another rail type available */

   458

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

   459

		assert(railtype < RAILTYPE_END);

   460

		FOR_ALL_PLAYERS(p) {

   461

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

   462

		}

   463

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

   464

		/* maybe make another road type available */

   465

		FOR_ALL_PLAYERS(p) {

   466

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

   467

		}

   468

	}

   469

   470

	SetDParam(0, GetEngineCategoryName(index));

   471

	SetDParam(1, index);

   472

	AddNewsItem(STR_NEW_VEHICLE_NOW_AVAILABLE_WITH_TYPE, NS_NEW_VEHICLES, index, 0);

   473

}

   474

   475

void EnginesMonthlyLoop()

   476

{

   477

	if (_cur_year < YEAR_ENGINE_AGING_STOPS) {

   478

		Engine *e;

   479

		FOR_ALL_ENGINES(e) {

   480

			/* Age the vehicle */

   481

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

   482

				e->age++;

   483

				CalcEngineReliability(e);

   484

			}

   485

   486

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

   487

				/* Introduce it to all players */

   488

				NewVehicleAvailable(e);

   489

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