1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "table/strings.h"

     8

#include "engine.h"

     9

#include "gfx.h"

    10

#include "player.h"

    11

#include "command.h"

    12

#include "vehicle.h"

    13

#include "news.h"

    14

#include "saveload.h"

    15

#include "variables.h"

    16

#include "train.h"

    17

#include "aircraft.h"

    18

#include "newgrf_cargo.h"

    19

#include "date.h"

    20

#include "table/engines.h"

    21

    22

EngineInfo _engine_info[TOTAL_NUM_ENGINES];

    23

RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

    24

ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

    25

AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

    26

RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

    27

    28

enum {

    29

	ENGINE_AVAILABLE   = 1,

    30

	ENGINE_INTRODUCING = 2,

    31

	ENGINE_PREVIEWING  = 4,

    32

};

    33

    34

enum {

    35

	YEAR_ENGINE_AGING_STOPS = 2050,

    36

};

    37

    38

    39

void ShowEnginePreviewWindow(EngineID engine);

    40

    41

void DeleteCustomEngineNames(void)

    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(void)

    56

{

    57

	/* XXX: not done */

    58

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

    59

}

    60

    61

static void SetupEngineNames(void)

    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

static void AdjustAvailAircraft(void)

    73

{

    74

	byte avail = 0;

    75

	if (_cur_year >= 1955) avail |= 2; // big airport

    76

	if (_cur_year <  1960 || _patches.always_small_airport) avail |= 1;  // small airport

    77

	if (_cur_year >= 1963) avail |= 4; // enable heliport

    78

    79

	if (avail != _avail_aircraft) {

    80

		_avail_aircraft = avail;

    81

		InvalidateWindow(WC_BUILD_STATION, 0);

    82

	}

    83

}

    84

    85

static void CalcEngineReliability(Engine *e)

    86

{

    87

	uint age = e->age;

    88

    89

	if (age < e->duration_phase_1) {

    90

		uint start = e->reliability_start;

    91

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

    92

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

    93

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

    94

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

    95

		e->reliability = e->reliability_max;

    96

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

    97

		uint max = e->reliability_max;

    98

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

    99

	} else {

   100

		/* time's up for this engine.

   101

		 * We will now completely retire this design */

   102

		e->player_avail = 0;

   103

		e->reliability = e->reliability_final;

   104

		InvalidateWindowClassesData(WC_BUILD_VEHICLE); // Kick this engine out of the lists

   105

	}

   106

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

   107

}

   108

   109

void AddTypeToEngines(void)

   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(void)

   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

	AdjustAvailAircraft();

   181

}

   182

   183

static void AcceptEnginePreview(EngineID eid, PlayerID player)

   184

{

   185

	Engine *e = GetEngine(eid);

   186

   187

	SETBIT(e->player_avail, player);

   188

	if (e->type == VEH_Train) {

   189

		const RailVehicleInfo *rvi = RailVehInfo(eid);

   190

		Player *p = GetPlayer(player);

   191

   192

		assert(rvi->railtype < RAILTYPE_END);

   193

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

   194

	}

   195

   196

	e->preview_player = INVALID_PLAYER;

   197

	if (player == _local_player) {

   198

		InvalidateWindowClassesData(WC_BUILD_VEHICLE);

   199

		InvalidateWindowClasses(WC_REPLACE_VEHICLE);

   200

	}

   201

}

   202

   203

static PlayerID GetBestPlayer(PlayerID pp)

   204

{

   205

	const Player *p;

   206

	int32 best_hist;

   207

	PlayerID best_player;

   208

	uint mask = 0;

   209

   210

	do {

   211

		best_hist = -1;

   212

		best_player = PLAYER_SPECTATOR;

   213

		FOR_ALL_PLAYERS(p) {

   214

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

   215

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

   216

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

   217

				best_player = p->index;

   218

			}

   219

		}

   220

   221

		if (best_player == PLAYER_SPECTATOR) return PLAYER_SPECTATOR;

   222

   223

		SETBIT(mask, best_player);

   224

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

   225

   226

	return best_player;

   227

}

   228

   229

void EnginesDailyLoop(void)

   230

{

   231

	EngineID i;

   232

   233

	if (_cur_year >= YEAR_ENGINE_AGING_STOPS) return;

   234

   235

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

   236

		Engine *e = &_engines[i];

   237

   238

		if (e->flags & ENGINE_INTRODUCING) {

   239

			if (e->flags & ENGINE_PREVIEWING) {

   240

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

   241

					e->flags &= ~ENGINE_PREVIEWING;

   242

					DeleteWindowById(WC_ENGINE_PREVIEW, i);

   243

					e->preview_player++;

   244

				}

   245

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

   246

				PlayerID best_player = GetBestPlayer(e->preview_player);

   247

   248

				if (best_player == PLAYER_SPECTATOR) {

   249

					e->preview_player = INVALID_PLAYER;

   250

					continue;

   251

				}

   252

   253

				if (!IsHumanPlayer(best_player)) {

   254

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

   255

					AcceptEnginePreview(i, best_player);

   256

				} else {

   257

					e->flags |= ENGINE_PREVIEWING;

   258

					e->preview_wait = 20;

   259

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

   260

				}

   261

			}

   262

		}

   263

	}

   264

}

   265

   266

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

   267

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

   268

 * @param tile unused

   269

 * @param p1 engine-prototype offered

   270

 * @param p2 unused

   271

 */

   272

int32 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 0;

   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_INTRODUCING) {

   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_INTRODUCING) | ENGINE_AVAILABLE;

   322

	InvalidateWindowClassesData(WC_BUILD_VEHICLE);

   323

	InvalidateWindowClasses(WC_REPLACE_VEHICLE);

   324

   325

	// Now available for all players

   326

	e->player_avail = (byte)-1;

   327

   328

	// Do not introduce new rail wagons

   329

	if (IsWagon(index)) return;

   330

   331

	if (index < NUM_TRAIN_ENGINES) {

   332

		// maybe make another rail type available

   333

		RailType railtype = RailVehInfo(index)->railtype;

   334

		assert(railtype < RAILTYPE_END);

   335

		FOR_ALL_PLAYERS(p) {

   336

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

   337

		}

   338

   339

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

   340

	} else if (index < NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES) {

   341

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

   342

	} else if (index < NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES) {

   343

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

   344

	} else {

   345

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

   346

	}

   347

}

   348

   349

void EnginesMonthlyLoop(void)

   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_INTRODUCING)) && _date >= e->intro_date) {

   365

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

   366

				e->flags |= ENGINE_INTRODUCING;

   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

	AdjustAvailAircraft();

   375

}

   376

   377

/** Rename an engine.

   378

 * @param tile unused

   379

 * @param p1 engine ID to rename

   380

 * @param p2 unused

   381

 */

   382

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

   383

{

   384

	StringID str;

   385

   386

	if (!IsEngineIndex(p1) || _cmd_text[0] == '\0') return CMD_ERROR;

   387

   388

	str = AllocateNameUnique(_cmd_text, 0);

   389

	if (str == 0) return CMD_ERROR;

   390

   391

	if (flags & DC_EXEC) {

   392

		StringID old_str = _engine_name_strings[p1];

   393

		_engine_name_strings[p1] = str;

   394

		DeleteName(old_str);

   395

		_vehicle_design_names |= 3;

   396

		MarkWholeScreenDirty();

   397

	} else {

   398

		DeleteName(str);

   399

	}

   400

   401

	return 0;

   402

}

   403

   404

   405

/*

   406

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

   407

 * the given player, false otherwise

   408

 *

   409

 * engine = index of the engine to check

   410

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

   411

 * player = index of the player

   412

 */

   413

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

   414

{

   415

	const Engine *e;

   416

   417

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

   418

	if (!IsEngineIndex(engine)) return false;

   419

   420

	e = GetEngine(engine);

   421

   422

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

   423

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

   424

   425

	// check if it's available

   426

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

   427

   428

	return true;

   429

}

   430

   431

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

   432

 * Engine Replacement stuff

   433

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

   434

   435

static void EngineRenewPoolNewBlock(uint start_item);

   436

   437

DEFINE_OLD_POOL(EngineRenew, EngineRenew, EngineRenewPoolNewBlock, NULL)

   438

   439

static void EngineRenewPoolNewBlock(uint start_item)

   440

{

   441

	EngineRenew *er;

   442

   443

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

   444

	 *  TODO - This is just a temporary stage, this will be removed. */

   445

	for (er = GetEngineRenew(start_item); er != NULL; er = (er->index + 1U < GetEngineRenewPoolSize()) ? GetEngineRenew(er->index + 1U) : NULL) {

   446

		er->index = start_item++;

   447

		er->from = INVALID_ENGINE;

   448

	}

   449

}

   450

   451

   452

static EngineRenew *AllocateEngineRenew(void)

   453

{

   454

	EngineRenew *er;

   455

   456

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

   457

	 *  TODO - This is just a temporary stage, this will be removed. */

   458

	for (er = GetEngineRenew(0); er != NULL; er = (er->index + 1U < GetEngineRenewPoolSize()) ? GetEngineRenew(er->index + 1U) : NULL) {

   459

		if (IsValidEngineRenew(er)) continue;

   460

   461

		er->to = INVALID_ENGINE;

   462

		er->next = NULL;

   463

		return er;

   464

	}

   465

   466

	/* Check if we can add a block to the pool */

   467

	if (AddBlockToPool(&_EngineRenew_pool)) return AllocateEngineRenew();

   468

   469

	return NULL;

   470

}

   471

   472

/**

   473

 * Retrieves the EngineRenew that specifies the replacement of the given

   474

 * engine type from the given renewlist */

   475

static EngineRenew *GetEngineReplacement(EngineRenewList erl, EngineID engine)

   476

{

   477

	EngineRenew *er = (EngineRenew *)erl;

   478

   479

	while (er) {

   480

		if (er->from == engine) return er;

   481

		er = er->next;

   482

	}

   483

	return NULL;

   484

}

   485

   486

void RemoveAllEngineReplacement(EngineRenewList *erl)

   487

{

   488

	EngineRenew *er = (EngineRenew *)(*erl);

   489

	EngineRenew *next;

   490

   491

	while (er) {

   492

		next = er->next;

   493

		DeleteEngineRenew(er);

   494

		er = next;