1

/* $Id$ */

     2

     3

/** @file newgrf_engine.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "debug.h"

     9

#include "engine.h"

    10

#include "train.h"

    11

#include "player.h"

    12

#include "station.h"

    13

#include "airport.h"

    14

#include "newgrf.h"

    15

#include "newgrf_callbacks.h"

    16

#include "newgrf_engine.h"

    17

#include "newgrf_station.h"

    18

#include "newgrf_spritegroup.h"

    19

#include "newgrf_cargo.h"

    20

#include "cargotype.h"

    21

#include "date_func.h"

    23

    24

    25

int _traininfo_vehicle_pitch = 0;

    26

int _traininfo_vehicle_width = 29;

    27

    28

struct WagonOverride {

    29

	byte *train_id;

    30

	int trains;

    31

	CargoID cargo;

    32

	const SpriteGroup *group;

    33

};

    34

    35

struct WagonOverrides {

    36

	int overrides_count;

    37

	WagonOverride *overrides;

    38

};

    39

    40

static WagonOverrides _engine_wagon_overrides[TOTAL_NUM_ENGINES];

    41

    42

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

    43

{

    44

	WagonOverrides *wos;

    45

	WagonOverride *wo;

    46

    47

	assert(engine < TOTAL_NUM_ENGINES);

    48

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

    49

    50

	wos = &_engine_wagon_overrides[engine];

    51

	wos->overrides_count++;

    52

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

    53

    54

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

    55

	/* FIXME: If we are replacing an override, release original SpriteGroup

    56

	 * to prevent leaks. But first we need to refcount the SpriteGroup.

    57

	 * --pasky */

    58

	wo->group = group;

    59

	wo->cargo = cargo;

    60

	wo->trains = trains;

    61

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

    62

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

    63

}

    64

    65

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

    66

{

    67

	const WagonOverrides *wos = &_engine_wagon_overrides[engine];

    68

    69

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

    70

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

    71

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

    72

	 * that. --pasky */

    73

    74

	for (int i = 0; i < wos->overrides_count; i++) {

    75

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

    76

    77

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

    78

    79

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

    80

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

    81

		}

    82

	}

    83

	return NULL;

    84

}

    85

    86

/**

    87

 * Unload all wagon override sprite groups.

    88

 */

    89

void UnloadWagonOverrides()

    90

{

    91

	WagonOverrides *wos;

    92

	WagonOverride *wo;

    93

	EngineID engine;

    94

	int i;

    95

    96

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

    97

		wos = &_engine_wagon_overrides[engine];

    98

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

    99

			wo = &wos->overrides[i];

   100

			wo->group = NULL;

   101

			free(wo->train_id);

   102

		}

   103

		free(wos->overrides);

   104

		wos->overrides_count = 0;

   105

		wos->overrides = NULL;

   106

	}

   107

}

   108

   109

/* Space for NUM_CARGO real cargos and 2 pseudo cargos, CT_DEFAULT and CT_PURCHASE */

   110

static const SpriteGroup *_engine_custom_sprites[TOTAL_NUM_ENGINES][NUM_CARGO + 2];

   111

static const GRFFile *_engine_grf[TOTAL_NUM_ENGINES];

   112

   113

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

   114

{

   115

	assert(engine < lengthof(_engine_custom_sprites));

   116

	assert(cargo < lengthof(*_engine_custom_sprites));

   117

   118

	if (_engine_custom_sprites[engine][cargo] != NULL) {

   119

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

   120

	}

   121

	_engine_custom_sprites[engine][cargo] = group;

   122

}

   123

   124

/**

   125

 * Unload all engine sprite groups.

   126

 */

   127

void UnloadCustomEngineSprites()

   128

{

   129

	memset(_engine_custom_sprites, 0, sizeof(_engine_custom_sprites));

   130

	memset(_engine_grf, 0, sizeof(_engine_grf));

   131

}

   132

   133

static const SpriteGroup *heli_rotor_custom_sprites[NUM_AIRCRAFT_ENGINES];

   134

   135

/** Load a rotor override sprite group for an aircraft */

   136

void SetRotorOverrideSprites(EngineID engine, const SpriteGroup *group)

   137

{

   138

	assert(engine >= AIRCRAFT_ENGINES_INDEX);

   139

	assert(engine < AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES);

   140

   141

	if (heli_rotor_custom_sprites[engine - AIRCRAFT_ENGINES_INDEX] != NULL) {

   142

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

   143

	}

   144

	heli_rotor_custom_sprites[engine - AIRCRAFT_ENGINES_INDEX] = group;

   145

}

   146

   147

/** Unload all rotor override sprite groups */

   148

void UnloadRotorOverrideSprites()

   149

{

   150

	EngineID engine;

   151

   152

	/* Starting at AIRCRAFT_ENGINES_INDEX may seem pointless, but it means

   153

	 * the context of EngineID is correct */

   154

	for (engine = AIRCRAFT_ENGINES_INDEX; engine < AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES; engine++) {

   155

		heli_rotor_custom_sprites[engine - AIRCRAFT_ENGINES_INDEX] = NULL;

   156

	}

   157

}

   158

   159

   160

/**

   161

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

   162

 * etc during a game.

   163

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

   164

 * @param file   Pointer of GRFFile to tie.

   165

 */

   166

void SetEngineGRF(EngineID engine, const GRFFile *file)

   167

{

   168

	assert(engine < TOTAL_NUM_ENGINES);

   169

	_engine_grf[engine] = file;

   170

}

   171

   172

   173

/**

   174

 * Retrieve the GRFFile tied to an engine

   175

 * @param engine Engine ID to retrieve.

   176

 * @return Pointer to GRFFile.

   177

 */

   178

const GRFFile *GetEngineGRF(EngineID engine)

   179

{

   180

	assert(engine < TOTAL_NUM_ENGINES);

   181

	return _engine_grf[engine];

   182

}

   183

   184

   185

/**

   186

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

   187

 * @param engine Engine ID to retrieve.

   188

 * @return 32 bit GRFID value.

   189

 */

   190

uint32 GetEngineGRFID(EngineID engine)

   191

{

   192

	assert(engine < TOTAL_NUM_ENGINES);

   193

	return _engine_grf[engine]->grfid;

   194

}

   195

   196

   197

static int MapOldSubType(const Vehicle *v)

   198

{

   199

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

   200

	if (IsTrainEngine(v)) return 0;

   201

	if (IsFreeWagon(v)) return 4;

   202

	return 2;

   203

}

   204

   205

   206

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

   207

enum {

   208

	AMS_TTDP_HANGAR,

   209

	AMS_TTDP_TO_HANGAR,

   210

	AMS_TTDP_TO_PAD1,

   211

	AMS_TTDP_TO_PAD2,

   212

	AMS_TTDP_TO_PAD3,

   213

	AMS_TTDP_TO_ENTRY_2_AND_3,

   214

	AMS_TTDP_TO_ENTRY_2_AND_3_AND_H,

   215

	AMS_TTDP_TO_JUNCTION,

   216

	AMS_TTDP_LEAVE_RUNWAY,

   217

	AMS_TTDP_TO_INWAY,

   218

	AMS_TTDP_TO_RUNWAY,

   219

	AMS_TTDP_TO_OUTWAY,

   220

	AMS_TTDP_WAITING,

   221

	AMS_TTDP_TAKEOFF,

   222

	AMS_TTDP_TO_TAKEOFF,

   223

	AMS_TTDP_CLIMBING,

   224

	AMS_TTDP_FLIGHT_APPROACH,

   225

	AMS_TTDP_UNUSED_0x11,

   226

	AMS_TTDP_FLIGHT_TO_TOWER,

   227

	AMS_TTDP_UNUSED_0x13,

   228

	AMS_TTDP_FLIGHT_FINAL,

   229

	AMS_TTDP_FLIGHT_DESCENT,

   230

	AMS_TTDP_BRAKING,

   231

	AMS_TTDP_HELI_TAKEOFF_AIRPORT,

   232

	AMS_TTDP_HELI_TO_TAKEOFF_AIRPORT,

   233

	AMS_TTDP_HELI_LAND_AIRPORT,

   234

	AMS_TTDP_HELI_TAKEOFF_HELIPORT,

   235

	AMS_TTDP_HELI_TO_TAKEOFF_HELIPORT,

   236

	AMS_TTDP_HELI_LAND_HELIPORT,

   237

};

   238

   239

   240

/**

   241

 * Map OTTD aircraft movement states to TTDPatch style movement states

   242

 * (VarAction 2 Variable 0xE2)

   243

 */

   244

static byte MapAircraftMovementState(const Vehicle *v)

   245

{

   246

	const Station *st = GetStation(v->u.air.targetairport);

   247

	if (st->airport_tile == 0) return AMS_TTDP_FLIGHT_TO_TOWER;

   248

   249

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

   250

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

   251

   252

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

   253

		case HANGAR:

   254

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

   255

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

   256

			 * AMED_HELI_LOWER some time before actually descending. */

   257

   258

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

   259

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

   260

			if (amdflag & AMED_HELI_LOWER) return AMS_TTDP_HELI_LAND_AIRPORT;

   261

   262

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

   263

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

   264

			if (amdflag & AMED_SLOWTURN) return AMS_TTDP_FLIGHT_TO_TOWER;

   265

   266

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

   267

			 * Has reached hanger? */

   268

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_HANGAR;

   269

   270

			/* Still moving towards hanger. */

   271

			return AMS_TTDP_TO_HANGAR;

   272

   273

		case TERM1:

   274

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD1;

   275

			return AMS_TTDP_TO_JUNCTION;

   276

   277

		case TERM2:

   278

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD2;

   279

			return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H;

   280

   281

		case TERM3:

   282

		case TERM4:

   283

		case TERM5:

   284

		case TERM6:

   285

		case TERM7:

   286

		case TERM8:

   287

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

   288

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD3;

   289

			return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H;

   290

   291

		case HELIPAD1:

   292

		case HELIPAD2:

   293

		case HELIPAD3:

   294

		case HELIPAD4: // Will only occur for helicopters.

   295

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

   296

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

   297

			return AMS_TTDP_TO_JUNCTION; // On the ground.

   298

   299

		case TAKEOFF: // Moving to takeoff position.

   300

			return AMS_TTDP_TO_OUTWAY;

   301

   302

		case STARTTAKEOFF: // Accelerating down runway.

   303

			return AMS_TTDP_TAKEOFF;

   304

   305

		case ENDTAKEOFF: // Ascent

   306

			return AMS_TTDP_CLIMBING;

   307

   308

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

   309

			if (afc->delta_z == 0) {

   310

				return amdflag & AMED_HELI_RAISE ?

   311

					AMS_TTDP_HELI_TAKEOFF_AIRPORT : AMS_TTDP_TO_JUNCTION;

   312

			} else {

   313

				return AMS_TTDP_HELI_TAKEOFF_HELIPORT;

   314

			}

   315

   316

		case FLYING:

   317

			return amdflag & AMED_HOLD ? AMS_TTDP_FLIGHT_APPROACH : AMS_TTDP_FLIGHT_TO_TOWER;

   318

   319

		case LANDING: // Descent

   320

			return AMS_TTDP_FLIGHT_DESCENT;

   321

   322

		case ENDLANDING: // On the runway braking

   323

			if (amdflag & AMED_BRAKE) return AMS_TTDP_BRAKING;

   324

			/* Landed - moving off runway */

   325

			return AMS_TTDP_TO_INWAY;

   326

   327

		case HELILANDING:

   328

		case HELIENDLANDING: // Helicoptor is decending.

   329

			if (amdflag & AMED_HELI_LOWER) {

   330

				return afc->delta_z == 0 ?

   331

					AMS_TTDP_HELI_LAND_AIRPORT : AMS_TTDP_HELI_LAND_HELIPORT;

   332

			} else {

   333

				return AMS_TTDP_FLIGHT_TO_TOWER;

   334

			}

   335

   336

		default:

   337

			return AMS_TTDP_HANGAR;

   338

	}

   339

}

   340

   341

   342

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

   343

enum {

   344

	AMA_TTDP_IN_HANGAR,

   345

	AMA_TTDP_ON_PAD1,

   346

	AMA_TTDP_ON_PAD2,

   347

	AMA_TTDP_ON_PAD3,

   348

	AMA_TTDP_HANGAR_TO_PAD1,

   349

	AMA_TTDP_HANGAR_TO_PAD2,

   350

	AMA_TTDP_HANGAR_TO_PAD3,

   351

	AMA_TTDP_LANDING_TO_PAD1,

   352

	AMA_TTDP_LANDING_TO_PAD2,

   353

	AMA_TTDP_LANDING_TO_PAD3,

   354

	AMA_TTDP_PAD1_TO_HANGAR,

   355

	AMA_TTDP_PAD2_TO_HANGAR,

   356

	AMA_TTDP_PAD3_TO_HANGAR,

   357

	AMA_TTDP_PAD1_TO_TAKEOFF,

   358

	AMA_TTDP_PAD2_TO_TAKEOFF,

   359

	AMA_TTDP_PAD3_TO_TAKEOFF,

   360

	AMA_TTDP_HANGAR_TO_TAKOFF,

   361

	AMA_TTDP_LANDING_TO_HANGAR,

   362

	AMA_TTDP_IN_FLIGHT,

   363

};

   364

   365

   366

/**

   367

 * Map OTTD aircraft movement states to TTDPatch style movement actions

   368

 * (VarAction 2 Variable 0xE6)

   369

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

   370

 */

   371

static byte MapAircraftMovementAction(const Vehicle *v)

   372

{

   373

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

   374

		case HANGAR:

   375

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

   376

   377

		case TERM1:

   378

		case HELIPAD1:

   379

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

   380

   381

		case TERM2:

   382

		case HELIPAD2:

   383

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

   384

   385

		case TERM3:

   386

		case TERM4:

   387

		case TERM5:

   388

		case TERM6:

   389

		case TERM7:

   390

		case TERM8:

   391

		case HELIPAD3:

   392

		case HELIPAD4:

   393

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

   394

   395

		case TAKEOFF:      // Moving to takeoff position

   396

		case STARTTAKEOFF: // Accelerating down runway

   397

		case ENDTAKEOFF:   // Ascent

   398

		case HELITAKEOFF:

   399

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

   400

			return AMA_TTDP_PAD1_TO_TAKEOFF;

   401

   402

		case FLYING:

   403

			return AMA_TTDP_IN_FLIGHT;

   404

   405

		case LANDING:    // Descent

   406

		case ENDLANDING: // On the runway braking

   407

		case HELILANDING:

   408

		case HELIENDLANDING:

   409

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

   410

			return (v->current_order.type == OT_GOTO_DEPOT) ?

   411

				AMA_TTDP_LANDING_TO_HANGAR : AMA_TTDP_LANDING_TO_PAD1;

   412

   413

		default:

   414

			return AMA_TTDP_IN_HANGAR;

   415

	}

   416

}

   417

   418

   419

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

   420

enum {

   421

	ATP_TTDP_SMALL,

   422

	ATP_TTDP_LARGE,

   423

	ATP_TTDP_HELIPORT,

   424

	ATP_TTDP_OILRIG,

   425

};

   426

   427

   428

/* Vehicle Resolver Functions */

   429

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

   430

{

   431

	return object->scope == VSG_SCOPE_SELF ? object->u.vehicle.self : object->u.vehicle.parent;

   432

}

   433

   434

   435

static uint32 VehicleGetRandomBits(const ResolverObject *object)

   436

{

   437

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

   438

}

   439

   440

   441

static uint32 VehicleGetTriggers(const ResolverObject *object)

   442

{

   443

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

   444

}

   445

   446

   447

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

   448

{

   449

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

   450

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

   451

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

   452

	 */

   453

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

   454

   455

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

   456

	 * other time is an error. */

   457

	assert(object->trigger != 0);

   458

   459

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

   460

}

   461

   462

   463

static uint32 GetGRFParameter(EngineID engine_type, byte parameter)

   464

{

   465

	const GRFFile *file = GetEngineGRF(engine_type);

   466

   467

	if (parameter >= file->param_end) return 0;

   468

	return file->param[parameter];

   469

}

   470

   471

   472

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

   473

{

   474

	const Livery *l;

   475

   476

	if (v == NULL) {

   477

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

   478

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

   479

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

   480

	} else {

   481

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

   482

	}

   483

   484

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

   485

}

   486

   487

   488

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