1

/* $Id$ */

     2

     3

/** @file newgrf_engine.cpp NewGRF handling of engines. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "debug.h"

     9

#include "engine_func.h"

    10

#include "engine_base.h"

    11

#include "train.h"

    12

#include "company_func.h"

    13

#include "company_base.h"

    14

#include "station_base.h"

    15

#include "airport.h"

    16

#include "newgrf.h"

    17

#include "newgrf_callbacks.h"

    18

#include "newgrf_engine.h"

    19

#include "newgrf_station.h"

    20

#include "newgrf_spritegroup.h"

    21

#include "newgrf_cargo.h"

    22

#include "cargotype.h"

    23

#include "date_func.h"

    24

#include "vehicle_func.h"

    25

#include "core/random_func.hpp"

    26

#include "direction_func.h"

    27

#include "rail_map.h"

    28

#include "rail.h"

    29

#include "settings_type.h"

    30

#include "aircraft.h"

    32

#include <map>

    33

    34

    35

int _traininfo_vehicle_pitch = 0;

    36

int _traininfo_vehicle_width = 29;

    37

    38

struct WagonOverride {

    39

	EngineID *train_id;

    40

	uint trains;

    41

	CargoID cargo;

    42

	const SpriteGroup *group;

    43

};

    44

    45

void SetWagonOverrideSprites(EngineID engine, CargoID cargo, const SpriteGroup *group, EngineID *train_id, uint trains)

    46

{

    47

	Engine *e = GetEngine(engine);

    48

	WagonOverride *wo;

    49

    50

	assert(cargo < NUM_CARGO + 2); // Include CT_DEFAULT and CT_PURCHASE pseudo cargos.

    51

    52

	e->overrides_count++;

    53

	e->overrides = ReallocT(e->overrides, e->overrides_count);

    54

    55

	wo = &e->overrides[e->overrides_count - 1];

    56

	wo->group = group;

    57

	wo->cargo = cargo;

    58

	wo->trains = trains;

    59

	wo->train_id = MallocT<EngineID>(trains);

    60

	memcpy(wo->train_id, train_id, trains * sizeof *train_id);

    61

}

    62

    63

const SpriteGroup *GetWagonOverrideSpriteSet(EngineID engine, CargoID cargo, EngineID overriding_engine)

    64

{

    65

	const Engine *e = GetEngine(engine);

    66

    67

	/* XXX: This could turn out to be a timesink on profiles. We could

    68

	 * always just dedicate 65535 bytes for an [engine][train] trampoline

    69

	 * for O(1). Or O(logMlogN) and searching binary tree or smt. like

    70

	 * that. --pasky */

    71

    72

	for (uint i = 0; i < e->overrides_count; i++) {

    73

		const WagonOverride *wo = &e->overrides[i];

    74

    75

		if (wo->cargo != cargo && wo->cargo != CT_DEFAULT) continue;

    76

    77

		for (uint j = 0; j < wo->trains; j++) {

    78

			if (wo->train_id[j] == overriding_engine) return wo->group;

    79

		}

    80

	}

    81

	return NULL;

    82

}

    83

    84

/**

    85

 * Unload all wagon override sprite groups.

    86

 */

    87

void UnloadWagonOverrides(Engine *e)

    88

{

    89

	for (uint i = 0; i < e->overrides_count; i++) {

    90

		WagonOverride *wo = &e->overrides[i];

    91

		free(wo->train_id);

    92

	}

    93

	free(e->overrides);

    94

	e->overrides_count = 0;

    95

	e->overrides = NULL;

    96

}

    97

    98

    99

void SetCustomEngineSprites(EngineID engine, byte cargo, const SpriteGroup *group)

   100

{

   101

	Engine *e = GetEngine(engine);

   102

	assert(cargo < lengthof(e->group));

   103

   104

	if (e->group[cargo] != NULL) {

   105

		grfmsg(6, "SetCustomEngineSprites: engine %d cargo %d already has group -- replacing", engine, cargo);

   106

	}

   107

	e->group[cargo] = group;

   108

}

   109

   110

   111

/**

   112

 * Tie a GRFFile entry to an engine, to allow us to retrieve GRF parameters

   113

 * etc during a game.

   114

 * @param engine Engine ID to tie the GRFFile to.

   115

 * @param file   Pointer of GRFFile to tie.

   116

 */

   117

void SetEngineGRF(EngineID engine, const GRFFile *file)

   118

{

   119

	Engine *e = GetEngine(engine);

   120

	e->grffile = file;

   121

}

   122

   123

   124

/**

   125

 * Retrieve the GRFFile tied to an engine

   126

 * @param engine Engine ID to retrieve.

   127

 * @return Pointer to GRFFile.

   128

 */

   129

const GRFFile *GetEngineGRF(EngineID engine)

   130

{

   131

	return GetEngine(engine)->grffile;

   132

}

   133

   134

   135

/**

   136

 * Retrieve the GRF ID of the GRFFile tied to an engine

   137

 * @param engine Engine ID to retrieve.

   138

 * @return 32 bit GRFID value.

   139

 */

   140

uint32 GetEngineGRFID(EngineID engine)

   141

{

   142

	return GetEngineGRF(engine)->grfid;

   143

}

   144

   145

   146

static int MapOldSubType(const Vehicle *v)

   147

{

   148

	if (v->type != VEH_TRAIN) return v->subtype;

   149

	if (IsTrainEngine(v)) return 0;

   150

	if (IsFreeWagon(v)) return 4;

   151

	return 2;

   152

}

   153

   154

   155

/* TTDP style aircraft movement states for GRF Action 2 Var 0xE2 */

   156

enum {

   157

	AMS_TTDP_HANGAR,

   158

	AMS_TTDP_TO_HANGAR,

   159

	AMS_TTDP_TO_PAD1,

   160

	AMS_TTDP_TO_PAD2,

   161

	AMS_TTDP_TO_PAD3,

   162

	AMS_TTDP_TO_ENTRY_2_AND_3,

   163

	AMS_TTDP_TO_ENTRY_2_AND_3_AND_H,

   164

	AMS_TTDP_TO_JUNCTION,

   165

	AMS_TTDP_LEAVE_RUNWAY,

   166

	AMS_TTDP_TO_INWAY,

   167

	AMS_TTDP_TO_RUNWAY,

   168

	AMS_TTDP_TO_OUTWAY,

   169

	AMS_TTDP_WAITING,

   170

	AMS_TTDP_TAKEOFF,

   171

	AMS_TTDP_TO_TAKEOFF,

   172

	AMS_TTDP_CLIMBING,

   173

	AMS_TTDP_FLIGHT_APPROACH,

   174

	AMS_TTDP_UNUSED_0x11,

   175

	AMS_TTDP_FLIGHT_TO_TOWER,

   176

	AMS_TTDP_UNUSED_0x13,

   177

	AMS_TTDP_FLIGHT_FINAL,

   178

	AMS_TTDP_FLIGHT_DESCENT,

   179

	AMS_TTDP_BRAKING,

   180

	AMS_TTDP_HELI_TAKEOFF_AIRPORT,

   181

	AMS_TTDP_HELI_TO_TAKEOFF_AIRPORT,

   182

	AMS_TTDP_HELI_LAND_AIRPORT,

   183

	AMS_TTDP_HELI_TAKEOFF_HELIPORT,

   184

	AMS_TTDP_HELI_TO_TAKEOFF_HELIPORT,

   185

	AMS_TTDP_HELI_LAND_HELIPORT,

   186

};

   187

   188

   189

/**

   190

 * Map OTTD aircraft movement states to TTDPatch style movement states

   191

 * (VarAction 2 Variable 0xE2)

   192

 */

   193

static byte MapAircraftMovementState(const Vehicle *v)

   194

{

   195

	const Station *st = GetTargetAirportIfValid(v);

   196

	if (st == NULL) return AMS_TTDP_FLIGHT_TO_TOWER;

   197

   198

	const AirportFTAClass *afc = st->Airport();

   199

	uint16 amdflag = afc->MovingData(v->u.air.pos)->flag;

   200

   201

	switch (v->u.air.state) {

   202

		case HANGAR:

   203

			/* The international airport is a special case as helicopters can land in

   204

			 * front of the hanger. Helicopters also change their air.state to

   205

			 * AMED_HELI_LOWER some time before actually descending. */

   206

   207

			/* This condition only occurs for helicopters, during descent,

   208

			 * to a landing by the hanger of an international airport. */

   209

			if (amdflag & AMED_HELI_LOWER) return AMS_TTDP_HELI_LAND_AIRPORT;

   210

   211

			/* This condition only occurs for helicopters, before starting descent,

   212

			 * to a landing by the hanger of an international airport. */

   213

			if (amdflag & AMED_SLOWTURN) return AMS_TTDP_FLIGHT_TO_TOWER;

   214

   215

			/* The final two conditions apply to helicopters or aircraft.

   216

			 * Has reached hanger? */

   217

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_HANGAR;

   218

   219

			/* Still moving towards hanger. */

   220

			return AMS_TTDP_TO_HANGAR;

   221

   222

		case TERM1:

   223

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD1;

   224

			return AMS_TTDP_TO_JUNCTION;

   225

   226

		case TERM2:

   227

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD2;

   228

			return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H;

   229

   230

		case TERM3:

   231

		case TERM4:

   232

		case TERM5:

   233

		case TERM6:

   234

		case TERM7:

   235

		case TERM8:

   236

			/* TTDPatch only has 3 terminals, so treat these states the same */

   237

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD3;

   238

			return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H;

   239

   240

		case HELIPAD1:

   241

		case HELIPAD2:

   242

		case HELIPAD3:

   243

		case HELIPAD4: // Will only occur for helicopters.

   244

			if (amdflag & AMED_HELI_LOWER) return AMS_TTDP_HELI_LAND_AIRPORT; // Descending.

   245

			if (amdflag & AMED_SLOWTURN)   return AMS_TTDP_FLIGHT_TO_TOWER;   // Still hasn't started descent.

   246

			return AMS_TTDP_TO_JUNCTION; // On the ground.

   247

   248

		case TAKEOFF: // Moving to takeoff position.

   249

			return AMS_TTDP_TO_OUTWAY;

   250

   251

		case STARTTAKEOFF: // Accelerating down runway.

   252

			return AMS_TTDP_TAKEOFF;

   253

   254

		case ENDTAKEOFF: // Ascent

   255

			return AMS_TTDP_CLIMBING;

   256

   257

		case HELITAKEOFF: // Helicopter is moving to take off position.

   258

			if (afc->delta_z == 0) {

   259

				return amdflag & AMED_HELI_RAISE ?

   260

					AMS_TTDP_HELI_TAKEOFF_AIRPORT : AMS_TTDP_TO_JUNCTION;

   261

			} else {

   262

				return AMS_TTDP_HELI_TAKEOFF_HELIPORT;

   263

			}

   264

   265

		case FLYING:

   266

			return amdflag & AMED_HOLD ? AMS_TTDP_FLIGHT_APPROACH : AMS_TTDP_FLIGHT_TO_TOWER;

   267

   268

		case LANDING: // Descent

   269

			return AMS_TTDP_FLIGHT_DESCENT;

   270

   271

		case ENDLANDING: // On the runway braking

   272

			if (amdflag & AMED_BRAKE) return AMS_TTDP_BRAKING;

   273

			/* Landed - moving off runway */

   274

			return AMS_TTDP_TO_INWAY;

   275

   276

		case HELILANDING:

   277

		case HELIENDLANDING: // Helicoptor is decending.

   278

			if (amdflag & AMED_HELI_LOWER) {

   279

				return afc->delta_z == 0 ?

   280

					AMS_TTDP_HELI_LAND_AIRPORT : AMS_TTDP_HELI_LAND_HELIPORT;

   281

			} else {

   282

				return AMS_TTDP_FLIGHT_TO_TOWER;

   283

			}

   284

   285

		default:

   286

			return AMS_TTDP_HANGAR;

   287

	}

   288

}

   289

   290

   291

/* TTDP style aircraft movement action for GRF Action 2 Var 0xE6 */

   292

enum {

   293

	AMA_TTDP_IN_HANGAR,

   294

	AMA_TTDP_ON_PAD1,

   295

	AMA_TTDP_ON_PAD2,

   296

	AMA_TTDP_ON_PAD3,

   297

	AMA_TTDP_HANGAR_TO_PAD1,

   298

	AMA_TTDP_HANGAR_TO_PAD2,

   299

	AMA_TTDP_HANGAR_TO_PAD3,

   300

	AMA_TTDP_LANDING_TO_PAD1,

   301

	AMA_TTDP_LANDING_TO_PAD2,

   302

	AMA_TTDP_LANDING_TO_PAD3,

   303

	AMA_TTDP_PAD1_TO_HANGAR,

   304

	AMA_TTDP_PAD2_TO_HANGAR,

   305

	AMA_TTDP_PAD3_TO_HANGAR,

   306

	AMA_TTDP_PAD1_TO_TAKEOFF,

   307

	AMA_TTDP_PAD2_TO_TAKEOFF,

   308

	AMA_TTDP_PAD3_TO_TAKEOFF,

   309

	AMA_TTDP_HANGAR_TO_TAKOFF,

   310

	AMA_TTDP_LANDING_TO_HANGAR,

   311

	AMA_TTDP_IN_FLIGHT,

   312

};

   313

   314

   315

/**

   316

 * Map OTTD aircraft movement states to TTDPatch style movement actions

   317

 * (VarAction 2 Variable 0xE6)

   318

 * This is not fully supported yet but it's enough for Planeset.

   319

 */

   320

static byte MapAircraftMovementAction(const Vehicle *v)

   321

{

   322

	switch (v->u.air.state) {

   323

		case HANGAR:

   324

			return (v->cur_speed > 0) ? AMA_TTDP_LANDING_TO_HANGAR : AMA_TTDP_IN_HANGAR;

   325

   326

		case TERM1:

   327

		case HELIPAD1:

   328

			return (v->current_order.IsType(OT_LOADING)) ? AMA_TTDP_ON_PAD1 : AMA_TTDP_LANDING_TO_PAD1;

   329

   330

		case TERM2:

   331

		case HELIPAD2:

   332

			return (v->current_order.IsType(OT_LOADING)) ? AMA_TTDP_ON_PAD2 : AMA_TTDP_LANDING_TO_PAD2;

   333

   334

		case TERM3:

   335

		case TERM4:

   336

		case TERM5:

   337

		case TERM6:

   338

		case TERM7:

   339

		case TERM8:

   340

		case HELIPAD3:

   341

		case HELIPAD4:

   342

			return (v->current_order.IsType(OT_LOADING)) ? AMA_TTDP_ON_PAD3 : AMA_TTDP_LANDING_TO_PAD3;

   343

   344

		case TAKEOFF:      // Moving to takeoff position

   345

		case STARTTAKEOFF: // Accelerating down runway

   346

		case ENDTAKEOFF:   // Ascent

   347

		case HELITAKEOFF:

   348

			/* @todo Need to find which terminal (or hanger) we've come from. How? */

   349

			return AMA_TTDP_PAD1_TO_TAKEOFF;

   350

   351

		case FLYING:

   352

			return AMA_TTDP_IN_FLIGHT;

   353

   354

		case LANDING:    // Descent

   355

		case ENDLANDING: // On the runway braking

   356

		case HELILANDING:

   357

		case HELIENDLANDING:

   358

			/* @todo Need to check terminal we're landing to. Is it known yet? */

   359

			return (v->current_order.IsType(OT_GOTO_DEPOT)) ?

   360

				AMA_TTDP_LANDING_TO_HANGAR : AMA_TTDP_LANDING_TO_PAD1;

   361

   362

		default:

   363

			return AMA_TTDP_IN_HANGAR;

   364

	}

   365

}

   366

   367

   368

/* TTDP airport types. Used to map our types to TTDPatch's */

   369

enum {

   370

	ATP_TTDP_SMALL,

   371

	ATP_TTDP_LARGE,

   372

	ATP_TTDP_HELIPORT,

   373

	ATP_TTDP_OILRIG,

   374

};

   375

   376

   377

/* Vehicle Resolver Functions */

   378

static inline const Vehicle *GRV(const ResolverObject *object)

   379

{

   380

	switch (object->scope) {

   381

		default: NOT_REACHED();

   382

		case VSG_SCOPE_SELF: return object->u.vehicle.self;

   383

		case VSG_SCOPE_PARENT: return object->u.vehicle.parent;

   384

		case VSG_SCOPE_RELATIVE: {

   385

			const Vehicle *v = NULL;

   386

			switch (GB(object->count, 6, 2)) {

   387

				default: NOT_REACHED();

   388

				case 0x00: // count back (away from the engine), starting at this vehicle

   389

				case 0x01: // count forward (toward the engine), starting at this vehicle

   390

					v = object->u.vehicle.self;

   391

					break;

   392

				case 0x02: // count back, starting at the engine

   393

					v = object->u.vehicle.parent;

   394

					break;

   395

				case 0x03: { // count back, starting at the first vehicle in this chain of vehicles with the same ID, as for vehicle variable 41

   396

					const Vehicle *self = object->u.vehicle.self;

   397

					for (const Vehicle *u = self->First(); u != self; u = u->Next()) {

   398

						if (u->engine_type != self->engine_type) {

   399

							v = NULL;

   400

						} else {

   401

							if (v == NULL) v = u;

   402

						}

   403

					}

   404

					if (v == NULL) v = self;

   405

				} break;

   406

			}

   407

			uint32 count = GB(object->count, 0, 4);

   408

			if (count == 0) count = GetRegister(0x100);

   409

			while (v != NULL && count-- != 0) v = (GB(object->count, 6, 2) == 0x01) ? v->Previous() : v->Next();

   410

			return v;

   411

		}

   412

	}

   413

}

   414

   415

   416

static uint32 VehicleGetRandomBits(const ResolverObject *object)

   417

{

   418

	return GRV(object) == NULL ? 0 : GRV(object)->random_bits;

   419

}

   420

   421

   422

static uint32 VehicleGetTriggers(const ResolverObject *object)

   423

{

   424

	return GRV(object) == NULL ? 0 : GRV(object)->waiting_triggers;

   425

}

   426

   427

   428

static void VehicleSetTriggers(const ResolverObject *object, int triggers)

   429

{

   430

	/* Evil cast to get around const-ness. This used to be achieved by an

   431

	 * innocent looking function pointer cast... Currently I cannot see a

   432

	 * way of avoiding this without removing consts deep within gui code.

   433

	 */

   434

	Vehicle *v = (Vehicle*)GRV(object);

   435

   436

	/* This function must only be called when processing triggers -- any

   437

	 * other time is an error. */

   438

	assert(object->trigger != 0);

   439

   440

	if (v != NULL) v->waiting_triggers = triggers;

   441

}

   442

   443

   444

static uint8 LiveryHelper(EngineID engine, const Vehicle *v)

   445

{

   446

	const Livery *l;

   447

   448

	if (v == NULL) {

   449

		if (!IsValidCompanyID(_current_company)) return 0;

   450

		l = GetEngineLivery(engine, _current_company, INVALID_ENGINE, NULL);

   451

	} else if (v->type == VEH_TRAIN) {

   452

		l = GetEngineLivery((v->u.rail.first_engine != INVALID_ENGINE && (IsArticulatedPart(v) || UsesWagonOverride(v))) ? v->u.rail.first_engine : v->engine_type, v->owner, v->u.rail.first_engine, v);

   453

	} else {

   454

		l = GetEngineLivery(v->engine_type, v->owner, INVALID_ENGINE, v);

   455

	}

   456

   457

	return l->colour1 + l->colour2 * 16;

   458

}

   459

   460

   461

static uint32 VehicleGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available)

   462

{

   463

	const Vehicle *v = GRV(object);

   464

   465

	if (v == NULL) {

   466

		/* Vehicle does not exist, so we're in a purchase list */

   467

		switch (variable) {

   468

			case 0x43: return _current_company | (LiveryHelper(object->u.vehicle.self_type, NULL) << 24); // Owner information

   469

			case 0x46: return 0;               // Motion counter

   470

			case 0x48: return GetEngine(object->u.vehicle.self_type)->flags; // Vehicle Type Info

   471

			case 0x49: return _cur_year; // 'Long' format build year

   472

			case 0xC4: return Clamp(_cur_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR; // Build year

   473

			case 0xDA: return INVALID_VEHICLE; // Next vehicle

   474

		}

   475

   476

		*available = false;

   477

		return UINT_MAX;

   478

	}

   479

   480

	/* Calculated vehicle parameters */

   481

	switch (variable) {

   482

		case 0x40: // Get length of consist

   483

		case 0x41: // Get length of same consecutive wagons

   484

			{

   485

				const Vehicle* u;

   486

				byte chain_before = 0;

   487