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 "ai/ai.h"

    30

#include "core/alloc_func.hpp"

    31

#include "vehicle_func.h"

    32

#include "map"

    33

    34

#include "table/strings.h"

    35

#include "table/engines.h"

    36

    37

DEFINE_OLD_POOL_GENERIC(Engine, Engine)

    38

    39

enum {

    40

	YEAR_ENGINE_AGING_STOPS = 2050,

    41

};

    42

    43

    44

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

    45

const uint8 _engine_counts[4] = {

    46

	lengthof(_orig_rail_vehicle_info),

    47

	lengthof(_orig_road_vehicle_info),

    48

	lengthof(_orig_ship_vehicle_info),

    49

	lengthof(_orig_aircraft_vehicle_info),

    50

};

    51

    52

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

    53

const uint8 _engine_offsets[4] = {

    54

	0,

    55

	lengthof(_orig_rail_vehicle_info),

    56

	lengthof(_orig_rail_vehicle_info) + lengthof(_orig_road_vehicle_info),

    57

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

    58

};

    59

    60

Engine::Engine() :

    61

	name(NULL),

    62

	overrides_count(0),

    63

	overrides(NULL)

    64

{

    65

}

    66

    67

Engine::Engine(VehicleType type, EngineID base)

    68

{

    69

	this->type = type;

    70

	this->internal_id = base;

    71

	this->list_position = base;

    72

    73

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

    74

	if (base >= _engine_counts[type]) {

    75

		/* Mark engine as valid anyway */

    76

		this->info.climates = 0x80;

    77

		return;

    78

	}

    79

    80

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

    81

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

    82

    83

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

    84

	switch (type) {

    85

		default: NOT_REACHED();

    86

    87

		case VEH_TRAIN:

    88

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

    89

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

    90

			this->info.string_id = STR_8000_KIRBY_PAUL_TANK_STEAM + base;

    91

			break;

    92

    93

		case VEH_ROAD:

    94

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

    95

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

    96

			this->info.string_id = STR_8074_MPS_REGAL_BUS + base;

    97

			break;

    98

    99

		case VEH_SHIP:

   100

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

   101

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

   102

			this->info.string_id = STR_80CC_MPS_OIL_TANKER + base;

   103

			break;

   104

   105

		case VEH_AIRCRAFT:

   106

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

   107

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

   108

			this->info.string_id = STR_80D7_SAMPSON_U52 + base;

   109

			break;

   110

	}

   111

}

   112

   113

Engine::~Engine()

   114

{

   115

	UnloadWagonOverrides(this);

   116

	free(this->name);

   117

}

   118

   119

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

   120

 * @param el list to be sorted

   121

 * @param compare function for evaluation of the quicksort

   122

 */

   123

void EngList_Sort(EngineList *el, EngList_SortTypeFunction compare)

   124

{

   125

	size_t size = el->size();

   126

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

   127

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

   128

	if (size < 2) return;

   129

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

   130

}

   131

   132

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

   133

 * @param el list to be sorted

   134

 * @param compare function for evaluation of the quicksort

   135

 * @param begin start of sorting

   136

 * @param num_items count of items to be sorted

   137

 */

   138

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

   139

{

   140

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

   141

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

   142

	if (num_items < 2) return;

   143

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

   144

}

   145

   146

   147

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

   148

 */

   149

void SetCachedEngineCounts()

   150

{

   151

	uint engines = GetEnginePoolSize();

   152

   153

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

   154

	Player *p;

   155

	FOR_ALL_PLAYERS(p) {

   156

		free(p->num_engines);

   157

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

   158

	}

   159

   160

	/* Recalculate */

   161

	Group *g;

   162

	FOR_ALL_GROUPS(g) {

   163

		free(g->num_engines);

   164

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

   165

	}

   166

   167

	const Vehicle *v;

   168

	FOR_ALL_VEHICLES(v) {

   169

		if (!IsEngineCountable(v)) continue;

   170

   171

		assert(v->engine_type < engines);

   172

   173

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

   174

   175

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

   176

   177

		g = GetGroup(v->group_id);

   178

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

   179

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

   180

   181

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

   182

	}

   183

}

   184

   185

void SetupEngines()

   186

{

   187

	_Engine_pool.CleanPool();

   188

	_Engine_pool.AddBlockToPool();

   189

   190

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

   191

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

   192

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

   193

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

   194

}

   195

   196

   197

void ShowEnginePreviewWindow(EngineID engine);

   198

   199

void DeleteCustomEngineNames()

   200

{

   201

	Engine *e;

   202

	FOR_ALL_ENGINES(e) {

   203

		free(e->name);

   204

		e->name = NULL;

   205

	}

   206

   207

	_vehicle_design_names &= ~1;

   208

}

   209

   210

void LoadCustomEngineNames()

   211

{

   212

	/* XXX: not done */

   213

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

   214

}

   215

   216

static void CalcEngineReliability(Engine *e)

   217

{

   218

	uint age = e->age;

   219

   220

	/* Check for early retirement */

   221

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

   222

		int retire_early = e->info.retire_early;

   223

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

   224

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

   225

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

   226

			e->player_avail = 0;

   227

			AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   228

		}

   229

	}

   230

   231

	if (age < e->duration_phase_1) {

   232

		uint start = e->reliability_start;

   233

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

   234

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

   235

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

   236

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

   237

		e->reliability = e->reliability_max;

   238

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

   239

		uint max = e->reliability_max;

   240

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

   241

	} else {

   242

		/* time's up for this engine.

   243

		 * We will now completely retire this design */

   244

		e->player_avail = 0;

   245

		e->reliability = e->reliability_final;

   246

		/* Kick this engine out of the lists */

   247

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   248

	}

   249

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

   250

	InvalidateWindowClasses(WC_REPLACE_VEHICLE);

   251

}

   252

   253

void StartupEngines()

   254

{

   255

	Engine *e;

   256

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

   257

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

   258

   259

	FOR_ALL_ENGINES(e) {

   260

		const EngineInfo *ei = &e->info;

   261

		uint32 r;

   262

   263

		e->age = 0;

   264

		e->flags = 0;

   265

		e->player_avail = 0;

   266

   267

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

   268

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

   269

		 * added. */

   270

		r = Random();

   271

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

   272

		if (e->intro_date <= _date) {

   273

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

   274

			e->player_avail = (byte)-1;

   275

			e->flags |= ENGINE_AVAILABLE;

   276

		}

   277

   278

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

   279

		r = Random();

   280

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

   281

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

   282

   283

		r = Random();

   284

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

   285

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

   286

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

   287

   288

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

   289

   290

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

   291

		if (ei->unk2 & 0x80) {

   292

			e->age = 0xFFFF;

   293

		} else {

   294

			CalcEngineReliability(e);

   295

		}

   296

   297

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

   298

   299

		/* prevent certain engines from ever appearing. */

   300

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

   301

			e->flags |= ENGINE_AVAILABLE;

   302

			e->player_avail = 0;

   303

		}

   304

	}

   305

}

   306

   307

static void AcceptEnginePreview(EngineID eid, PlayerID player)

   308

{

   309

	Engine *e = GetEngine(eid);

   310

	Player *p = GetPlayer(player);

   311

   312

	SetBit(e->player_avail, player);

   313

	if (e->type == VEH_TRAIN) {

   314

		const RailVehicleInfo *rvi = RailVehInfo(eid);

   315

   316

		assert(rvi->railtype < RAILTYPE_END);

   317

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

   318

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

   319

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

   320

	}

   321

   322

	e->preview_player_rank = 0xFF;

   323

	if (player == _local_player) {

   324

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   325

	}

   326

}

   327

   328

static PlayerID GetBestPlayer(uint8 pp)

   329

{

   330

	const Player *p;

   331

	int32 best_hist;

   332

	PlayerID best_player;

   333

	uint mask = 0;

   334

   335

	do {

   336

		best_hist = -1;

   337

		best_player = PLAYER_SPECTATOR;

   338

		FOR_ALL_PLAYERS(p) {

   339

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

   340

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

   341

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

   342

				best_player = p->index;

   343

			}

   344

		}

   345

   346

		if (best_player == PLAYER_SPECTATOR) return PLAYER_SPECTATOR;

   347

   348

		SetBit(mask, best_player);

   349

	} while (--pp != 0);

   350

   351

	return best_player;

   352

}

   353

   354

void EnginesDailyLoop()

   355

{

   356

	if (_cur_year >= YEAR_ENGINE_AGING_STOPS) return;

   357

   358

	Engine *e;

   359

	FOR_ALL_ENGINES(e) {

   360

		EngineID i = e->index;

   361

		if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   362

			if (e->flags & ENGINE_OFFER_WINDOW_OPEN) {

   363

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

   364

					e->flags &= ~ENGINE_OFFER_WINDOW_OPEN;

   365

					DeleteWindowById(WC_ENGINE_PREVIEW, i);

   366

					e->preview_player_rank++;

   367

				}

   368

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

   369

				PlayerID best_player = GetBestPlayer(e->preview_player_rank);

   370

   371

				if (best_player == PLAYER_SPECTATOR) {

   372

					e->preview_player_rank = 0xFF;

   373

					continue;

   374

				}

   375

   376

				e->flags |= ENGINE_OFFER_WINDOW_OPEN;

   377

				e->preview_wait = 20;

   378

				AI_Event(best_player, new AIEventEnginePreview(i));

   379

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

   380

			}

   381

		}

   382

	}

   383

}

   384

   385

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

   386

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

   387

 * @param tile unused

   388

 * @param flags operation to perfom

   389

 * @param p1 engine-prototype offered

   390

 * @param p2 unused

   391

 */

   392

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

   393

{

   394

	Engine *e;

   395

   396

	if (!IsEngineIndex(p1)) return CMD_ERROR;

   397

	e = GetEngine(p1);

   398

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

   399

   400

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

   401

   402

	return CommandCost();

   403

}

   404

   405

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

   406

static bool IsWagon(EngineID index)

   407

{

   408

	const Engine *e = GetEngine(index);

   409

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

   410

}

   411

   412

StringID GetEngineCategoryName(EngineID engine);

   413

   414

static void NewVehicleAvailable(Engine *e)

   415

{

   416

	Vehicle *v;

   417

	Player *p;

   418

	EngineID index = e->index;

   419

   420

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

   421

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

   422

	if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   423

		FOR_ALL_PLAYERS(p) {

   424

			uint block_preview = p->block_preview;

   425

   426

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

   427

   428

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

   429

			p->block_preview = 20;

   430

   431

			FOR_ALL_VEHICLES(v) {

   432

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

   433

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

   434

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

   435

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

   436

						p->block_preview = block_preview;

   437

						break;

   438

					}

   439

				}

   440

			}

   441

		}

   442

	}

   443

   444

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

   445

	AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   446

   447

	/* Now available for all players */

   448

	e->player_avail = (byte)-1;

   449

   450

	/* Do not introduce new rail wagons */

   451

	if (IsWagon(index)) return;

   452

   453

	if (e->type == VEH_TRAIN) {

   454

		/* maybe make another rail type available */

   455

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

   456

		assert(railtype < RAILTYPE_END);

   457

		FOR_ALL_PLAYERS(p) {

   458

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

   459

		}

   460

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

   461

		/* maybe make another road type available */

   462

		FOR_ALL_PLAYERS(p) {

   463

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

   464

		}

   465

	}

   466

   467

	SetDParam(0, GetEngineCategoryName(index));

   468

	SetDParam(1, index);

   469

	AddNewsItem(STR_NEW_VEHICLE_NOW_AVAILABLE_WITH_TYPE, NS_NEW_VEHICLES, index, 0);

   470

}

   471

   472

void EnginesMonthlyLoop()

   473

{

   474

	if (_cur_year < YEAR_ENGINE_AGING_STOPS) {

   475

		Engine *e;

   476

		FOR_ALL_ENGINES(e) {

   477

			/* Age the vehicle */

   478

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

   479

				e->age++;

   480

				CalcEngineReliability(e);

   481

			}

   482

   483

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

   484

				/* Introduce it to all players */

   485

				NewVehicleAvailable(e);

   486

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

   487

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

   488

				e->flags |= ENGINE_EXCLUSIVE_PREVIEW;

   489