1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "variables.h"

     6

#include "debug.h"

     7

#include "functions.h"

     8

#include "engine.h"

     9

#include "train.h"

    10

#include "player.h"

    11

#include "station.h"

    12

#include "airport.h"

    13

#include "newgrf.h"

    14

#include "newgrf_callbacks.h"

    15

#include "newgrf_engine.h"

    16

#include "newgrf_station.h"

    17

#include "newgrf_spritegroup.h"

    18

#include "newgrf_cargo.h"

    19

    20

    21

    22

/* Default cargo classes */

    23

static const uint16 _cargo_classes[NUM_GLOBAL_CID] = {

    24

	CC_PASSENGERS,

    25

	CC_BULK,

    26

	CC_MAIL,

    27

	CC_LIQUID,

    28

	CC_PIECE_GOODS,

    29

	CC_EXPRESS,

    30

	CC_BULK,

    31

	CC_PIECE_GOODS,

    32

	CC_BULK,

    33

	CC_PIECE_GOODS,

    34

	CC_ARMOURED,

    35

	CC_PIECE_GOODS,

    36

	CC_REFRIGERATED | CC_EXPRESS,

    37

	CC_REFRIGERATED | CC_EXPRESS,

    38

	CC_BULK,

    39

	CC_LIQUID,

    40

	CC_LIQUID,

    41

	CC_BULK,

    42

	CC_PIECE_GOODS,

    43

	CC_PIECE_GOODS,

    44

	CC_EXPRESS,

    45

	CC_BULK,

    46

	CC_LIQUID,

    47

	CC_BULK,

    48

	CC_PIECE_GOODS,

    49

	CC_LIQUID,

    50

	CC_PIECE_GOODS,

    51

	CC_PIECE_GOODS,

    52

	CC_NOAVAILABLE,

    53

	CC_NOAVAILABLE,

    54

	CC_NOAVAILABLE,

    55

};

    56

    57

int _traininfo_vehicle_pitch = 0;

    58

int _traininfo_vehicle_width = 29;

    59

    60

// TODO: We don't support cargo-specific wagon overrides. Pretty exotic... ;-) --pasky

    61

    62

typedef struct WagonOverride {

    63

	byte *train_id;

    64

	int trains;

    65

	const SpriteGroup *group;

    66

} WagonOverride;

    67

    68

typedef struct WagonOverrides {

    69

	int overrides_count;

    70

	WagonOverride *overrides;

    71

} WagonOverrides;

    72

    73

static WagonOverrides _engine_wagon_overrides[TOTAL_NUM_ENGINES];

    74

    75

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

    76

{

    77

	WagonOverrides *wos;

    78

	WagonOverride *wo;

    79

    80

	wos = &_engine_wagon_overrides[engine];

    81

	wos->overrides_count++;

    82

	wos->overrides = realloc(wos->overrides,

    83

		wos->overrides_count * sizeof(*wos->overrides));

    84

    85

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

    86

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

    87

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

    88

	 * --pasky */

    89

	wo->group = group;

    90

	wo->trains = trains;

    91

	wo->train_id = malloc(trains);

    92

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

    93

}

    94

    95

static const SpriteGroup *GetWagonOverrideSpriteSet(EngineID engine, byte overriding_engine)

    96

{

    97

	const WagonOverrides *wos = &_engine_wagon_overrides[engine];

    98

	int i;

    99

   100

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

   101

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

   102

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

   103

	// that. --pasky

   104

   105

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

   106

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

   107

		int j;

   108

   109

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

   110

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

   111

				return wo->group;

   112

		}

   113

	}

   114

	return NULL;

   115

}

   116

   117

/**

   118

 * Unload all wagon override sprite groups.

   119

 */

   120

void UnloadWagonOverrides(void)

   121

{

   122

	WagonOverrides *wos;

   123

	WagonOverride *wo;

   124

	EngineID engine;

   125

	int i;

   126

   127

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

   128

		wos = &_engine_wagon_overrides[engine];

   129

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

   130

			wo = &wos->overrides[i];

   131

			wo->group = NULL;

   132

			free(wo->train_id);

   133

		}

   134

		free(wos->overrides);

   135

		wos->overrides_count = 0;

   136

		wos->overrides = NULL;

   137

	}

   138

}

   139

   140

// 0 - 28 are cargos, 29 is default, 30 is the advert (purchase list)

   141

// (It isn't and shouldn't be like this in the GRF files since new cargo types

   142

// may appear in future - however it's more convenient to store it like this in

   143

// memory. --pasky)

   144

static const SpriteGroup *engine_custom_sprites[TOTAL_NUM_ENGINES][NUM_GLOBAL_CID];

   145

static const GRFFile *_engine_grf[TOTAL_NUM_ENGINES];

   146

   147

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

   148

{

   149

	assert(engine < TOTAL_NUM_ENGINES);

   150

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

   151

		DEBUG(grf, 6)("SetCustomEngineSprites: engine `%d' cargo `%d' already has group -- replacing.", engine, cargo);

   152

	}

   153

	engine_custom_sprites[engine][cargo] = group;

   154

}

   155

   156

/**

   157

 * Unload all engine sprite groups.

   158

 */

   159

void UnloadCustomEngineSprites(void)

   160

{

   161

	EngineID engine;

   162

	CargoID cargo;

   163

   164

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

   165

		for (cargo = 0; cargo < NUM_GLOBAL_CID; cargo++) {

   166

			engine_custom_sprites[engine][cargo] = NULL;

   167

		}

   168

		_engine_grf[engine] = 0;

   169

	}

   170

}

   171

   172

static const SpriteGroup *heli_rotor_custom_sprites[NUM_AIRCRAFT_ENGINES];

   173

   174

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

   175

void SetRotorOverrideSprites(EngineID engine, const SpriteGroup *group)

   176

{

   177

	assert(engine >= AIRCRAFT_ENGINES_INDEX);

   178

	assert(engine < AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES);

   179

   180

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

   181

		DEBUG(grf, 6)("SetRotorOverrideSprites: engine `%d' already has group -- replacing.", engine);

   182

	}

   183

	heli_rotor_custom_sprites[engine - AIRCRAFT_ENGINES_INDEX] = group;

   184

}

   185

   186

/** Unload all rotor override sprite groups */

   187

void UnloadRotorOverrideSprites(void)

   188

{

   189

	EngineID engine;

   190

   191

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

   192

	 * the context of EngineID is correct */

   193

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

   194

		heli_rotor_custom_sprites[engine - AIRCRAFT_ENGINES_INDEX] = NULL;

   195

	}

   196

}

   197

   198

   199

/**

   200

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

   201

 * etc during a game.

   202

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

   203

 * @param file   Pointer of GRFFile to tie.

   204

 */

   205

void SetEngineGRF(EngineID engine, const GRFFile *file)

   206

{

   207

	assert(engine < TOTAL_NUM_ENGINES);

   208

	_engine_grf[engine] = file;

   209

}

   210

   211

   212

/**

   213

 * Retrieve the GRFFile tied to an engine

   214

 * @param engine Engine ID to retrieve.

   215

 * @return Pointer to GRFFile.

   216

 */

   217

const GRFFile *GetEngineGRF(EngineID engine)

   218

{

   219

	assert(engine < TOTAL_NUM_ENGINES);

   220

	return _engine_grf[engine];

   221

}

   222

   223

   224

/**

   225

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

   226

 * @param engine Engine ID to retrieve.

   227

 * @return 32 bit GRFID value.

   228

 */

   229

uint32 GetEngineGRFID(EngineID engine)

   230

{

   231

	assert(engine < TOTAL_NUM_ENGINES);

   232

	return _engine_grf[engine]->grfid;

   233

}

   234

   235

   236

static int MapOldSubType(const Vehicle *v)

   237

{

   238

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

   239

	if (IsTrainEngine(v)) return 0;

   240

	if (IsFreeWagon(v)) return 4;

   241

	return 2;

   242

}

   243

   244

   245

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

   246

enum {

   247

	AMS_TTDP_HANGER,

   248

	AMS_TTDP_TO_HANGER,

   249

	AMS_TTDP_TO_PAD1,

   250

	AMS_TTDP_TO_PAD2,

   251

	AMS_TTDP_TO_PAD3,

   252

	AMS_TTDP_TO_ENTRY_2_AND_3,

   253

	AMS_TTDP_TO_ENTRY_2_AND_3_AND_H,

   254

	AMS_TTDP_TO_JUNCTION,

   255

	AMS_TTDP_LEAVE_RUNWAY,

   256

	AMS_TTDP_TO_INWAY,

   257

	AMS_TTDP_TO_RUNWAY,

   258

	AMS_TTDP_TO_OUTWAY,

   259

	AMS_TTDP_WAITING,

   260

	AMS_TTDP_TAKEOFF,

   261

	AMS_TTDP_TO_TAKEOFF,

   262

	AMS_TTDP_CLIMBING,

   263

	AMS_TTDP_FLIGHT_APPROACH,

   264

	AMS_TTDP_UNUSED_0x11,

   265

	AMS_TTDP_FLIGHT_TO_TOWER,

   266

	AMS_TTDP_UNUSED_0x13,

   267

	AMS_TTDP_FLIGHT_FINAL,

   268

	AMS_TTDP_FLIGHT_DESCENT,

   269

	AMS_TTDP_BRAKING,

   270

	AMS_TTDP_HELI_TAKEOFF_AIRPORT,

   271

	AMS_TTDP_HELI_TO_TAKEOFF_AIRPORT,

   272

	AMS_TTDP_HELI_LAND_AIRPORT,

   273

	AMS_TTDP_HELI_TAKEOFF_HELIPORT,

   274

	AMS_TTDP_HELI_TO_TAKEOFF_HELIPORT,

   275

	AMS_TTDP_HELI_LAND_HELIPORT,

   276

};

   277

   278

   279

/**

   280

 * Map OTTD aircraft movement states to TTDPatch style movement states

   281

 * (VarAction 2 Variable 0xE2)

   282

 */

   283

static byte MapAircraftMovementState(const Vehicle *v)

   284

{

   285

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

   286

	byte amdflag = GetAirportMovingData(st->airport_type, v->u.air.pos)->flag;

   287

   288

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

   289

		case HANGAR:

   290

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

   291

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

   292

			 * AMED_HELI_LOWER some time before actually descending. */

   293

   294

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

   295

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

   296

			if (amdflag & AMED_HELI_LOWER) return AMS_TTDP_HELI_LAND_AIRPORT;

   297

   298

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

   299

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

   300

			if (amdflag & AMED_SLOWTURN) return AMS_TTDP_FLIGHT_TO_TOWER;

   301

   302

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

   303

			/* Has reached hanger? */

   304

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_HANGER;

   305

   306

			// Still moving towards hanger.

   307

			return AMS_TTDP_TO_HANGER;

   308

   309

		case TERM1:

   310

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD1;

   311

			return AMS_TTDP_TO_JUNCTION;

   312

   313

		case TERM2:

   314

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD2;

   315

			return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H;

   316

   317

		case TERM3:

   318

		case TERM4:

   319

		case TERM5:

   320

		case TERM6:

   321

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

   322

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD3;

   323

			return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H;

   324

   325

		case HELIPAD1:

   326

		case HELIPAD2: // Will only occur for helicopters.

   327

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

   328

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

   329

			return AMS_TTDP_TO_JUNCTION; // On the ground.

   330

   331

		case TAKEOFF: // Moving to takeoff position.

   332

			return AMS_TTDP_TO_OUTWAY;

   333

   334

		case STARTTAKEOFF: // Accelerating down runway.

   335

			return AMS_TTDP_TAKEOFF;

   336

   337

		case ENDTAKEOFF: // Ascent

   338

			return AMS_TTDP_CLIMBING;

   339

   340

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

   341

			switch (st->airport_type) {

   342

				case AT_SMALL:

   343

				case AT_LARGE:

   344

				case AT_METROPOLITAN:

   345

				case AT_INTERNATIONAL:

   346

					if (amdflag & AMED_HELI_RAISE) return AMS_TTDP_HELI_TAKEOFF_AIRPORT;

   347

					return AMS_TTDP_TO_JUNCTION;

   348

   349

				case AT_HELIPORT:

   350

				case AT_OILRIG:

   351

					return AMS_TTDP_HELI_TAKEOFF_HELIPORT;

   352

   353

				default:

   354

					return AMS_TTDP_HELI_TAKEOFF_AIRPORT;

   355

			}

   356

   357

		case FLYING:

   358

			return AMS_TTDP_FLIGHT_TO_TOWER;

   359

   360

		case LANDING: // Descent

   361

			return AMS_TTDP_FLIGHT_DESCENT;

   362

   363

		case ENDLANDING: // On the runway braking

   364

			if (amdflag & AMED_BRAKE) return AMS_TTDP_BRAKING;

   365

			// Landed - moving off runway

   366

			return AMS_TTDP_TO_INWAY;

   367

   368

		case HELILANDING:

   369

		case HELIENDLANDING: // Helicoptor is decending.

   370

			if (amdflag & AMED_HELI_LOWER) {

   371

				switch (st->airport_type) {

   372

					case AT_HELIPORT:

   373

					case AT_OILRIG:

   374

						return AMS_TTDP_HELI_LAND_HELIPORT;

   375

   376

					default:

   377

						return AMS_TTDP_HELI_LAND_AIRPORT;

   378

				}

   379

			}

   380

			return AMS_TTDP_FLIGHT_TO_TOWER;

   381

   382

		default:

   383

			return AMS_TTDP_HANGER;

   384

	}

   385

}

   386

   387

   388

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

   389

enum {

   390

	AMA_TTDP_IN_HANGER,

   391

	AMA_TTDP_ON_PAD1,

   392

	AMA_TTDP_ON_PAD2,

   393

	AMA_TTDP_ON_PAD3,

   394

	AMA_TTDP_HANGER_TO_PAD1,

   395

	AMA_TTDP_HANGER_TO_PAD2,

   396

	AMA_TTDP_HANGER_TO_PAD3,

   397

	AMA_TTDP_LANDING_TO_PAD1,

   398

	AMA_TTDP_LANDING_TO_PAD2,

   399

	AMA_TTDP_LANDING_TO_PAD3,

   400

	AMA_TTDP_PAD1_TO_HANGER,

   401

	AMA_TTDP_PAD2_TO_HANGER,

   402

	AMA_TTDP_PAD3_TO_HANGER,

   403

	AMA_TTDP_PAD1_TO_TAKEOFF,

   404

	AMA_TTDP_PAD2_TO_TAKEOFF,

   405

	AMA_TTDP_PAD3_TO_TAKEOFF,

   406

	AMA_TTDP_HANGER_TO_TAKOFF,

   407

	AMA_TTDP_LANDING_TO_HANGER,

   408

	AMA_TTDP_IN_FLIGHT,

   409

};

   410

   411

   412

/**

   413

 * Map OTTD aircraft movement states to TTDPatch style movement actions

   414

 * (VarAction 2 Variable 0xE6)

   415

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

   416

 */

   417

static byte MapAircraftMovementAction(const Vehicle *v)

   418

{

   419

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

   420

		case HANGAR:

   421

			return (v->cur_speed > 0) ? AMA_TTDP_LANDING_TO_HANGER : AMA_TTDP_IN_HANGER;

   422

   423

		case TERM1:

   424

		case HELIPAD1:

   425

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

   426

   427

		case TERM2:

   428

		case HELIPAD2:

   429

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

   430

   431

		case TERM3:

   432

		case TERM4:

   433

		case TERM5:

   434

		case TERM6:

   435

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

   436

   437

		case TAKEOFF:      // Moving to takeoff position

   438

		case STARTTAKEOFF: // Accelerating down runway

   439

		case ENDTAKEOFF:   // Ascent

   440

		case HELITAKEOFF:

   441

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

   442

			return AMA_TTDP_PAD1_TO_TAKEOFF;

   443

   444

		case FLYING:

   445

			return AMA_TTDP_IN_FLIGHT;

   446

   447

		case LANDING:    // Descent

   448

		case ENDLANDING: // On the runway braking

   449

		case HELILANDING:

   450

		case HELIENDLANDING:

   451

			// TODO Need to check terminal we're landing to. Is it known yet?

   452

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

   453

				AMA_TTDP_LANDING_TO_HANGER : AMA_TTDP_LANDING_TO_PAD1;

   454

   455

		default:

   456

			return AMA_TTDP_IN_HANGER;

   457

	}

   458

}

   459

   460

   461

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

   462

enum {

   463

	ATP_TTDP_SMALL,

   464

	ATP_TTDP_LARGE,

   465

	ATP_TTDP_HELIPORT,

   466

	ATP_TTDP_OILRIG,

   467

};

   468

   469

   470

/* Vehicle Resolver Functions */

   471

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

   472

{

   473

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

   474

}

   475

   476

   477

static uint32 VehicleGetRandomBits(const ResolverObject *object)

   478

{

   479

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

   480

}

   481

   482

   483

static uint32 VehicleGetTriggers(const ResolverObject *object)

   484

{

   485

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

   486

}

   487

   488

   489

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

   490

{

   491

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

   492

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

   493

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