1

/* $Id$ */

     2

     3

/** @file engine.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "engine.h"

     9

#include "player_base.h"

    10

#include "player_func.h"

    11

#include "command_func.h"

    12

#include "news.h"

    13

#include "saveload.h"

    14

#include "variables.h"

    15

#include "train.h"

    16

#include "aircraft.h"

    17

#include "newgrf_cargo.h"

    18

#include "group.h"

    19

#include "misc/autoptr.hpp"

    20

#include "strings_func.h"

    21

#include "gfx_func.h"

    22

#include "functions.h"

    23

#include "window_func.h"

    24

#include "date_func.h"

    25

#include "autoreplace_base.h"

    26

#include "autoreplace_gui.h"

    27

#include "string_func.h"

    28

#include "settings_type.h"

    29

    30

#include "table/strings.h"

    31

#include "table/engines.h"

    32

    33

Engine _engines[TOTAL_NUM_ENGINES];

    34

EngineInfo _engine_info[TOTAL_NUM_ENGINES];

    35

RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

    36

ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

    37

AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

    38

RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

    39

    40

enum {

    41

	YEAR_ENGINE_AGING_STOPS = 2050,

    42

};

    43

    44

    45

void SetupEngines()

    46

{

    47

	/* Copy original static engine data */

    48

	memcpy(&_engine_info, &_orig_engine_info, sizeof(_orig_engine_info));

    49

	memcpy(&_rail_vehicle_info, &_orig_rail_vehicle_info, sizeof(_orig_rail_vehicle_info));

    50

	memcpy(&_ship_vehicle_info, &_orig_ship_vehicle_info, sizeof(_orig_ship_vehicle_info));

    51

	memcpy(&_aircraft_vehicle_info, &_orig_aircraft_vehicle_info, sizeof(_orig_aircraft_vehicle_info));

    52

	memcpy(&_road_vehicle_info, &_orig_road_vehicle_info, sizeof(_orig_road_vehicle_info));

    53

    54

	/* Add type to engines */

    55

	Engine* e = _engines;

    56

	do e->type = VEH_TRAIN;    while (++e < &_engines[ROAD_ENGINES_INDEX]);

    57

	do e->type = VEH_ROAD;     while (++e < &_engines[SHIP_ENGINES_INDEX]);

    58

	do e->type = VEH_SHIP;     while (++e < &_engines[AIRCRAFT_ENGINES_INDEX]);

    59

	do e->type = VEH_AIRCRAFT; while (++e < &_engines[TOTAL_NUM_ENGINES]);

    60

    61

	/* Set up default engine names */

    62

	for (EngineID engine = 0; engine < TOTAL_NUM_ENGINES; engine++) {

    63

		EngineInfo *ei = &_engine_info[engine];

    64

		ei->string_id = STR_8000_KIRBY_PAUL_TANK_STEAM + engine;

    65

	}

    66

}

    67

    68

    69

void ShowEnginePreviewWindow(EngineID engine);

    70

    71

void DeleteCustomEngineNames()

    72

{

    73

	Engine *e;

    74

	FOR_ALL_ENGINES(e) {

    75

		free(e->name);

    76

		e->name = NULL;

    77

	}

    78

    79

	_vehicle_design_names &= ~1;

    80

}

    81

    82

void LoadCustomEngineNames()

    83

{

    84

	/* XXX: not done */

    85

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

    86

}

    87

    88

static void CalcEngineReliability(Engine *e)

    89

{

    90

	uint age = e->age;

    91

    92

	/* Check for early retirement */

    93

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

    94

		uint retire_early = EngInfo(e - _engines)->retire_early;

    95

		if (retire_early > 0 && age >= e->duration_phase_1 + e->duration_phase_2 - retire_early * 12) {

    96

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

    97

			e->player_avail = 0;

    98

			AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

    99

		}

   100

	}

   101

   102

	if (age < e->duration_phase_1) {

   103

		uint start = e->reliability_start;

   104

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

   105

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

   106

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

   107

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

   108

		e->reliability = e->reliability_max;

   109

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

   110

		uint max = e->reliability_max;

   111

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

   112

	} else {

   113

		/* time's up for this engine.

   114

		 * We will now completely retire this design */

   115

		e->player_avail = 0;

   116

		e->reliability = e->reliability_final;

   117

		/* Kick this engine out of the lists */

   118

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   119

	}

   120

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

   121

	InvalidateWindowClasses(WC_REPLACE_VEHICLE);

   122

}

   123

   124

void StartupEngines()

   125

{

   126

	Engine *e;

   127

	const EngineInfo *ei;

   128

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

   129

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

   130

   131

	for (e = _engines, ei = _engine_info; e != endof(_engines); e++, ei++) {

   132

		uint32 r;

   133

   134

		e->age = 0;

   135

		e->flags = 0;

   136

		e->player_avail = 0;

   137

   138

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

   139

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

   140

		 * added. */

   141

		r = Random();

   142

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

   143

		if (e->intro_date <= _date) {

   144

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

   145

			e->player_avail = (byte)-1;

   146

			e->flags |= ENGINE_AVAILABLE;

   147

		}

   148

   149

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

   150

		r = Random();

   151

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

   152

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

   153

   154

		r = Random();

   155

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

   156

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

   157

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

   158

   159

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

   160

   161

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

   162

		if (ei->unk2 & 0x80) {

   163

			e->age = 0xFFFF;

   164

		} else {

   165

			CalcEngineReliability(e);

   166

		}

   167

   168

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

   169

   170

		/* prevent certain engines from ever appearing. */

   171

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

   172

			e->flags |= ENGINE_AVAILABLE;

   173

			e->player_avail = 0;

   174

		}

   175

   176

		/* This sets up type for the engine

   177

		 * It is needed if you want to ask the engine what type it is

   178

		 * It should hopefully be the same as when you ask a vehicle what it is

   179

		 * but using this, you can ask what type an engine number is

   180

		 * even if it is not a vehicle (yet)*/

   181

	}

   182

}

   183

   184

static void AcceptEnginePreview(EngineID eid, PlayerID player)

   185

{

   186

	Engine *e = GetEngine(eid);

   187

	Player *p = GetPlayer(player);

   188

   189

	SetBit(e->player_avail, player);

   190

	if (e->type == VEH_TRAIN) {

   191

		const RailVehicleInfo *rvi = RailVehInfo(eid);

   192

   193

		assert(rvi->railtype < RAILTYPE_END);

   194

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

   195

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

   196

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

   197

	}

   198

   199

	e->preview_player = INVALID_PLAYER;

   200

	if (player == _local_player) {

   201

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   202

	}

   203

}

   204

   205

static PlayerID GetBestPlayer(PlayerID pp)

   206

{

   207

	const Player *p;

   208

	int32 best_hist;

   209

	PlayerID best_player;

   210

	uint mask = 0;

   211

   212

	do {

   213

		best_hist = -1;

   214

		best_player = PLAYER_SPECTATOR;

   215

		FOR_ALL_PLAYERS(p) {

   216

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

   217

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

   218

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

   219

				best_player = p->index;

   220

			}

   221

		}

   222

   223

		if (best_player == PLAYER_SPECTATOR) return PLAYER_SPECTATOR;

   224

   225

		SetBit(mask, best_player);

   226

	} while (pp--, pp != 0);

   227

   228

	return best_player;

   229

}

   230

   231

void EnginesDailyLoop()

   232

{

   233

	EngineID i;

   234

   235

	if (_cur_year >= YEAR_ENGINE_AGING_STOPS) return;

   236

   237

	for (i = 0; i != lengthof(_engines); i++) {

   238

		Engine *e = &_engines[i];

   239

   240

		if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   241

			if (e->flags & ENGINE_OFFER_WINDOW_OPEN) {

   242

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

   243

					e->flags &= ~ENGINE_OFFER_WINDOW_OPEN;

   244

					DeleteWindowById(WC_ENGINE_PREVIEW, i);

   245

					e->preview_player++;

   246

				}

   247

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

   248

				PlayerID best_player = GetBestPlayer(e->preview_player);

   249

   250

				if (best_player == PLAYER_SPECTATOR) {

   251

					e->preview_player = INVALID_PLAYER;

   252

					continue;

   253

				}

   254

   255

				if (!IsHumanPlayer(best_player)) {

   256

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

   257

					AcceptEnginePreview(i, best_player);

   258

				} else {

   259

					e->flags |= ENGINE_OFFER_WINDOW_OPEN;

   260

					e->preview_wait = 20;

   261

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

   262

				}

   263

			}

   264

		}

   265

	}

   266

}

   267

   268

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

   269

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

   270

 * @param tile unused

   271

 * @param flags operation to perfom

   272

 * @param p1 engine-prototype offered

   273

 * @param p2 unused

   274

 */

   275

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

   276

{

   277

	Engine *e;

   278

   279

	if (!IsEngineIndex(p1)) return CMD_ERROR;

   280

	e = GetEngine(p1);

   281

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

   282

   283

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

   284

   285

	return CommandCost();

   286

}

   287

   288

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

   289

static bool IsWagon(EngineID index)

   290

{

   291

	return index < NUM_TRAIN_ENGINES && RailVehInfo(index)->railveh_type == RAILVEH_WAGON;

   292

}

   293

   294

static void NewVehicleAvailable(Engine *e)

   295

{

   296

	Vehicle *v;

   297

	Player *p;

   298

	EngineID index = e - _engines;

   299

   300

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

   301

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

   302

	if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   303

		FOR_ALL_PLAYERS(p) {

   304

			uint block_preview = p->block_preview;

   305

   306

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

   307

   308

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

   309

			p->block_preview = 20;

   310

   311

			FOR_ALL_VEHICLES(v) {

   312

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

   313

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

   314

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

   315

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

   316

						p->block_preview = block_preview;

   317

						break;

   318

					}

   319

				}

   320

			}

   321

		}

   322

	}

   323

   324

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

   325

	AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   326

   327

	/* Now available for all players */

   328

	e->player_avail = (byte)-1;

   329

   330

	/* Do not introduce new rail wagons */

   331

	if (IsWagon(index)) return;

   332

   333

	if (e->type == VEH_TRAIN) {

   334

		/* maybe make another rail type available */

   335

		RailType railtype = RailVehInfo(index)->railtype;

   336

		assert(railtype < RAILTYPE_END);

   337

		FOR_ALL_PLAYERS(p) {

   338

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

   339

		}

   340

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

   341

		/* maybe make another road type available */

   342

		FOR_ALL_PLAYERS(p) {

   343

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

   344

		}

   345

	}

   346

	AddNewsItem(index, NEWS_FLAGS(NM_CALLBACK, 0, NT_NEW_VEHICLES, DNC_VEHICLEAVAIL), 0, 0);

   347

}

   348

   349

void EnginesMonthlyLoop()

   350

{

   351

	Engine *e;

   352

   353

	if (_cur_year < YEAR_ENGINE_AGING_STOPS) {

   354

		for (e = _engines; e != endof(_engines); e++) {

   355

			/* Age the vehicle */

   356

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

   357

				e->age++;

   358

				CalcEngineReliability(e);

   359

			}

   360

   361

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

   362

				/* Introduce it to all players */

   363

				NewVehicleAvailable(e);

   364

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

   365

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

   366

				e->flags |= ENGINE_EXCLUSIVE_PREVIEW;

   367

   368

				/* Do not introduce new rail wagons */

   369

				if (!IsWagon(e - _engines))

   370

					e->preview_player = (PlayerID)1; // Give to the player with the highest rating.

   371

			}

   372

		}

   373

	}

   374

}

   375

   376

static bool IsUniqueEngineName(const char *name)

   377

{

   378

	char buf[512];

   379

   380

	for (EngineID i = 0; i < TOTAL_NUM_ENGINES; i++) {

   381

		SetDParam(0, i);

   382

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

   383

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

   384

	}

   385

   386

	return true;

   387

}

   388

   389

/** Rename an engine.

   390

 * @param tile unused

   391

 * @param flags operation to perfom

   392

 * @param p1 engine ID to rename

   393

 * @param p2 unused

   394

 */

   395

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

   396

{

   397

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

   398

   399

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

   400

   401

	if (flags & DC_EXEC) {

   402

		Engine *e = GetEngine(p1);

   403

		free(e->name);

   404

		e->name = strdup(_cmd_text);

   405

		_vehicle_design_names |= 3;

   406

		MarkWholeScreenDirty();

   407

	}

   408

   409

	return CommandCost();

   410

}

   411

   412

   413

/*

   414

 * returns true if an engine is valid, of the specified type, and buildable by

   415

 * the given player, false otherwise

   416

 *

   417

 * engine = index of the engine to check

   418

 * type   = the type the engine should be of (VEH_xxx)

   419

 * player = index of the player

   420

 */

   421

bool IsEngineBuildable(EngineID engine, byte type, PlayerID player)

   422

{

   423

	const Engine *e;

   424

   425

	/* check if it's an engine that is in the engine array */

   426

	if (!IsEngineIndex(engine)) return false;

   427

   428

	e = GetEngine(engine);

   429

   430

	/* check if it's an engine of specified type */

   431

	if (e->type != type) return false;

   432

   433

	/* check if it's available */

   434

	if (!HasBit(e->player_avail, player)) return false;

   435

   436

	if (type == VEH_TRAIN) {

   437

		/* Check if the rail type is available to this player */

   438

		const Player *p = GetPlayer(player);

   439

		if (!HasBit(p->avail_railtypes, RailVehInfo(engine)->railtype)) return false;

   440

	}

   441

   442

	return true;

   443

}

   444

   445

/** Get the default cargo type for a certain engine type

   446

 * @param engine The ID to get the cargo for

   447

 * @return The cargo type. CT_INVALID means no cargo capacity

   448

 */

   449

CargoID GetEngineCargoType(EngineID engine)

   450

{

   451

	assert(IsEngineIndex(engine));

   452

   453

	switch (GetEngine(engine)->type) {

   454

		case VEH_TRAIN:

   455

			if (RailVehInfo(engine)->capacity == 0) return CT_INVALID;

   456

			return RailVehInfo(engine)->cargo_type;

   457

   458

		case VEH_ROAD:

   459

			if (RoadVehInfo(engine)->capacity == 0) return CT_INVALID;

   460

			return RoadVehInfo(engine)->cargo_type;

   461

   462

		case VEH_SHIP:

   463

			if (ShipVehInfo(engine)->capacity == 0) return CT_INVALID;

   464

			return ShipVehInfo(engine)->cargo_type;

   465

   466

		case VEH_AIRCRAFT:

   467

			/* all aircraft starts as passenger planes with cargo capacity */

   468

			return CT_PASSENGERS;

   469

   470

		default: NOT_REACHED(); return CT_INVALID;

   471

	}

   472

}

   473

   474

/************************************************************************

   475

 * Engine Replacement stuff

   476

 ************************************************************************/

   477

   478

DEFINE_OLD_POOL_GENERIC(EngineRenew, EngineRenew)

   479

   480

/**

   481

 * Retrieves the EngineRenew that specifies the replacement of the given

   482

 * engine type from the given renewlist */

   483

static EngineRenew *GetEngineReplacement(EngineRenewList erl, EngineID engine, GroupID group)

   484

{

   485

	EngineRenew *er = (EngineRenew *)erl;

   486

   487

	while (er) {

   488

		if (er->from == engine && er->group_id == group) return er;