1

/* $Id$ */

     2

     3

/** @file engine.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "table/strings.h"

    10

#include "engine.h"

    11

#include "gfx.h"

    12

#include "player.h"

    13

#include "command.h"

    14

#include "vehicle.h"

    15

#include "news.h"

    16

#include "saveload.h"

    17

#include "variables.h"

    18

#include "train.h"

    19

#include "aircraft.h"

    20

#include "newgrf_cargo.h"

    21

#include "date.h"

    22

#include "table/engines.h"

    23

#include "group.h"

    24

#include "string.h"

    25

#include "strings.h"

    26

#include "misc/autoptr.hpp"

    27

    28

EngineInfo _engine_info[TOTAL_NUM_ENGINES];

    29

RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

    30

ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

    31

AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

    32

RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

    33

    34

enum {

    35

	YEAR_ENGINE_AGING_STOPS = 2050,

    36

};

    37

    38

    39

void ShowEnginePreviewWindow(EngineID engine);

    40

    41

void DeleteCustomEngineNames()

    42

{

    43

	uint i;

    44

	StringID old;

    45

    46

	for (i = 0; i != TOTAL_NUM_ENGINES; i++) {

    47

		old = _engine_name_strings[i];

    48

		_engine_name_strings[i] = i + STR_8000_KIRBY_PAUL_TANK_STEAM;

    49

		DeleteName(old);

    50

	}

    51

    52

	_vehicle_design_names &= ~1;

    53

}

    54

    55

void LoadCustomEngineNames()

    56

{

    57

	/* XXX: not done */

    58

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

    59

}

    60

    61

static void SetupEngineNames()

    62

{

    63

	StringID *name;

    64

    65

	for (name = _engine_name_strings; name != endof(_engine_name_strings); name++)

    66

		*name = STR_SV_EMPTY;

    67

    68

	DeleteCustomEngineNames();

    69

	LoadCustomEngineNames();

    70

}

    71

    72

    73

static void CalcEngineReliability(Engine *e)

    74

{

    75

	uint age = e->age;

    76

    77

	/* Check for early retirement */

    78

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

    79

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

    80

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

    81

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

    82

			e->player_avail = 0;

    83

			AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

    84

		}

    85

	}

    86

    87

	if (age < e->duration_phase_1) {

    88

		uint start = e->reliability_start;

    89

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

    90

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

    91

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

    92

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

    93

		e->reliability = e->reliability_max;

    94

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

    95

		uint max = e->reliability_max;

    96

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

    97

	} else {

    98

		/* time's up for this engine.

    99

		 * We will now completely retire this design */

   100

		e->player_avail = 0;

   101

		e->reliability = e->reliability_final;

   102

		/* Kick this engine out of the lists */

   103

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   104

	}

   105

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

   106

	InvalidateWindowClasses(WC_REPLACE_VEHICLE);

   107

}

   108

   109

void AddTypeToEngines()

   110

{

   111

	Engine* e = _engines;

   112

   113

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

   114

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

   115

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

   116

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

   117

}

   118

   119

void StartupEngines()

   120

{

   121

	Engine *e;

   122

	const EngineInfo *ei;

   123

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

   124

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

   125

   126

	SetupEngineNames();

   127

   128

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

   129

		uint32 r;

   130

   131

		e->age = 0;

   132

		e->flags = 0;

   133

		e->player_avail = 0;

   134

   135

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

   136

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

   137

		 * added. */

   138

		r = Random();

   139

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

   140

		if (e->intro_date <= _date) {

   141

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

   142

			e->player_avail = (byte)-1;

   143

			e->flags |= ENGINE_AVAILABLE;

   144

		}

   145

   146

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

   147

		r = Random();

   148

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

   149

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

   150

   151

		r = Random();

   152

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

   153

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

   154

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

   155

   156

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

   157

   158

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

   159

		if (ei->unk2 & 0x80) {

   160

			e->age = 0xFFFF;

   161

		} else {

   162

			CalcEngineReliability(e);

   163

		}

   164

   165

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

   166

   167

		/* prevent certain engines from ever appearing. */

   168

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

   169

			e->flags |= ENGINE_AVAILABLE;

   170

			e->player_avail = 0;

   171

		}

   172

   173

		/* This sets up type for the engine

   174

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

   175

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

   176

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

   177

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

   178

	}

   179

}

   180

   181

static void AcceptEnginePreview(EngineID eid, PlayerID player)

   182

{

   183

	Engine *e = GetEngine(eid);

   184

	Player *p = GetPlayer(player);

   185

   186

	SetBit(e->player_avail, player);

   187

	if (e->type == VEH_TRAIN) {

   188

		const RailVehicleInfo *rvi = RailVehInfo(eid);

   189

   190

		assert(rvi->railtype < RAILTYPE_END);

   191

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

   192

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

   193

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

   194

	}

   195

   196

	e->preview_player = INVALID_PLAYER;

   197

	if (player == _local_player) {

   198

		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   199

	}

   200

}

   201

   202

static PlayerID GetBestPlayer(PlayerID pp)

   203

{

   204

	const Player *p;

   205

	int32 best_hist;

   206

	PlayerID best_player;

   207

	uint mask = 0;

   208

   209

	do {

   210

		best_hist = -1;

   211

		best_player = PLAYER_SPECTATOR;

   212

		FOR_ALL_PLAYERS(p) {

   213

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

   214

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

   215

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

   216

				best_player = p->index;

   217

			}

   218

		}

   219

   220

		if (best_player == PLAYER_SPECTATOR) return PLAYER_SPECTATOR;

   221

   222

		SetBit(mask, best_player);

   223

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

   224

   225

	return best_player;

   226

}

   227

   228

void EnginesDailyLoop()

   229

{

   230

	EngineID i;

   231

   232

	if (_cur_year >= YEAR_ENGINE_AGING_STOPS) return;

   233

   234

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

   235

		Engine *e = &_engines[i];

   236

   237

		if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   238

			if (e->flags & ENGINE_OFFER_WINDOW_OPEN) {

   239

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

   240

					e->flags &= ~ENGINE_OFFER_WINDOW_OPEN;

   241

					DeleteWindowById(WC_ENGINE_PREVIEW, i);

   242

					e->preview_player++;

   243

				}

   244

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

   245

				PlayerID best_player = GetBestPlayer(e->preview_player);

   246

   247

				if (best_player == PLAYER_SPECTATOR) {

   248

					e->preview_player = INVALID_PLAYER;

   249

					continue;

   250

				}

   251

   252

				if (!IsHumanPlayer(best_player)) {

   253

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

   254

					AcceptEnginePreview(i, best_player);

   255

				} else {

   256

					e->flags |= ENGINE_OFFER_WINDOW_OPEN;

   257

					e->preview_wait = 20;

   258

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

   259

				}

   260

			}

   261

		}

   262

	}

   263

}

   264

   265

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

   266

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

   267

 * @param tile unused

   268

 * @param flags operation to perfom

   269

 * @param p1 engine-prototype offered

   270

 * @param p2 unused

   271

 */

   272

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

   273

{

   274

	Engine *e;

   275

   276

	if (!IsEngineIndex(p1)) return CMD_ERROR;

   277

	e = GetEngine(p1);

   278

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

   279

   280

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

   281

   282

	return CommandCost();

   283

}

   284

   285

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

   286

static bool IsWagon(EngineID index)

   287

{

   288

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

   289

}

   290

   291

static void NewVehicleAvailable(Engine *e)

   292

{

   293

	Vehicle *v;

   294

	Player *p;

   295

	EngineID index = e - _engines;

   296

   297

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

   298

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

   299

	if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {

   300

		FOR_ALL_PLAYERS(p) {

   301

			uint block_preview = p->block_preview;

   302

   303

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

   304

   305

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

   306

			p->block_preview = 20;

   307

   308

			FOR_ALL_VEHICLES(v) {

   309

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

   310

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

   311

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

   312

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

   313

						p->block_preview = block_preview;

   314

						break;

   315

					}

   316

				}

   317

			}

   318

		}

   319

	}

   320

   321

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

   322

	AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);

   323

   324

	/* Now available for all players */

   325

	e->player_avail = (byte)-1;

   326

   327

	/* Do not introduce new rail wagons */

   328

	if (IsWagon(index)) return;

   329

   330

	if (index < NUM_TRAIN_ENGINES) {

   331

		/* maybe make another rail type available */

   332

		RailType railtype = RailVehInfo(index)->railtype;

   333

		assert(railtype < RAILTYPE_END);

   334

		FOR_ALL_PLAYERS(p) {

   335

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

   336

		}

   337

	}

   338

	if ((index - NUM_TRAIN_ENGINES) < NUM_ROAD_ENGINES) {

   339

		/* maybe make another road type available */

   340

		FOR_ALL_PLAYERS(p) {

   341

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

   342

		}

   343

	}

   344

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

   345

}

   346

   347

void EnginesMonthlyLoop()

   348

{

   349

	Engine *e;

   350

   351

	if (_cur_year < YEAR_ENGINE_AGING_STOPS) {

   352

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

   353

			/* Age the vehicle */

   354

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

   355

				e->age++;

   356

				CalcEngineReliability(e);

   357

			}

   358

   359

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

   360

				/* Introduce it to all players */

   361

				NewVehicleAvailable(e);

   362

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

   363

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

   364

				e->flags |= ENGINE_EXCLUSIVE_PREVIEW;

   365

   366

				/* Do not introduce new rail wagons */

   367

				if (!IsWagon(e - _engines))

   368

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

   369

			}

   370

		}

   371

	}

   372

}

   373

   374

static bool IsUniqueEngineName(const char *name)

   375

{

   376

	char buf[512];

   377

   378

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

   379

		SetDParam(0, i);

   380

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

   381

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

   382

	}

   383

   384

	return true;

   385

}

   386

   387

/** Rename an engine.

   388

 * @param tile unused

   389

 * @param flags operation to perfom

   390

 * @param p1 engine ID to rename

   391

 * @param p2 unused

   392

 */

   393

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

   394

{

   395

	StringID str;

   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

	str = AllocateName(_cmd_text, 0);

   402

	if (str == 0) return CMD_ERROR;

   403

   404

	if (flags & DC_EXEC) {

   405

		StringID old_str = _engine_name_strings[p1];

   406

		_engine_name_strings[p1] = str;

   407

		DeleteName(old_str);

   408

		_vehicle_design_names |= 3;

   409

		MarkWholeScreenDirty();

   410

	} else {

   411

		DeleteName(str);

   412

	}

   413

   414

	return CommandCost();

   415

}

   416

   417

   418

/*

   419

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

   420

 * the given player, false otherwise

   421

 *

   422

 * engine = index of the engine to check

   423

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

   424

 * player = index of the player

   425

 */

   426

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

   427

{

   428

	const Engine *e;

   429

   430

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

   431

	if (!IsEngineIndex(engine)) return false;

   432

   433

	e = GetEngine(engine);

   434

   435

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

   436

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

   437

   438

	/* check if it's available */

   439

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

   440

   441

	if (type == VEH_TRAIN) {

   442

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

   443

		const Player *p = GetPlayer(player);

   444

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

   445

	}

   446

   447

	return true;

   448

}

   449

   450

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

   451

 * @param engine The ID to get the cargo for

   452

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

   453

 */

   454

CargoID GetEngineCargoType(EngineID engine)

   455

{

   456

	assert(IsEngineIndex(engine));

   457

   458

	switch (GetEngine(engine)->type) {

   459

		case VEH_TRAIN:

   460

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

   461

			return RailVehInfo(engine)->cargo_type;

   462

   463

		case VEH_ROAD:

   464

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

   465

			return RoadVehInfo(engine)->cargo_type;

   466

   467

		case VEH_SHIP:

   468

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

   469

			return ShipVehInfo(engine)->cargo_type;

   470

   471

		case VEH_AIRCRAFT:

   472

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

   473

			return CT_PASSENGERS;

   474

   475

		default: NOT_REACHED(); return CT_INVALID;

   476

	}

   477

}

   478

   479

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

   480

 * Engine Replacement stuff

   481

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

   482

   483

DEFINE_OLD_POOL_GENERIC(EngineRenew, EngineRenew)

   484

   485

/**

   486

 * Retrieves the EngineRenew that specifies the replacement of the given

   487

 * engine type from the given renewlist */

   488

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

   489

{

   490

	EngineRenew *er = (EngineRenew *)erl;