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

#include "date.h"

    20

    21

    22

    23

/* Default cargo classes */

    24

static const uint16 _cargo_classes[NUM_GLOBAL_CID] = {

    25

	CC_PASSENGERS,

    26

	CC_BULK,

    27

	CC_MAIL,

    28

	CC_LIQUID,

    29

	CC_PIECE_GOODS,

    30

	CC_EXPRESS,

    31

	CC_BULK,

    32

	CC_PIECE_GOODS,

    33

	CC_BULK,

    34

	CC_PIECE_GOODS,

    35

	CC_ARMOURED,

    36

	CC_PIECE_GOODS,

    37

	CC_REFRIGERATED | CC_EXPRESS,

    38

	CC_REFRIGERATED | CC_EXPRESS,

    39

	CC_BULK,

    40

	CC_LIQUID,

    41

	CC_LIQUID,

    42

	CC_BULK,

    43

	CC_PIECE_GOODS,

    44

	CC_PIECE_GOODS,

    45

	CC_EXPRESS,

    46

	CC_BULK,

    47

	CC_LIQUID,

    48

	CC_BULK,

    49

	CC_PIECE_GOODS,

    50

	CC_LIQUID,

    51

	CC_PIECE_GOODS,

    52

	CC_PIECE_GOODS,

    53

	CC_NOAVAILABLE,

    54

	CC_NOAVAILABLE,

    55

	CC_NOAVAILABLE,

    56

};

    57

    58

int _traininfo_vehicle_pitch = 0;

    59

int _traininfo_vehicle_width = 29;

    60

    61

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

    62

    63

typedef struct WagonOverride {

    64

	byte *train_id;

    65

	int trains;

    66

	const SpriteGroup *group;

    67

} WagonOverride;

    68

    69

typedef struct WagonOverrides {

    70

	int overrides_count;

    71

	WagonOverride *overrides;

    72

} WagonOverrides;

    73

    74

static WagonOverrides _engine_wagon_overrides[TOTAL_NUM_ENGINES];

    75

    76

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

    77

{

    78

	WagonOverrides *wos;

    79

	WagonOverride *wo;

    80

    81

	wos = &_engine_wagon_overrides[engine];

    82

	wos->overrides_count++;

    83

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

    84

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

    85

    86

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

    87

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

    88

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

    89

	 * --pasky */

    90

	wo->group = group;

    91

	wo->trains = trains;

    92

	wo->train_id = malloc(trains);

    93

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

    94

}

    95

    96

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

    97

{

    98

	const WagonOverrides *wos = &_engine_wagon_overrides[engine];

    99

	int i;

   100

   101

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

   102

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

   103

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

   104

	// that. --pasky

   105

   106

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

   107

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

   108

		int j;

   109

   110

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

   111

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

   112

				return wo->group;

   113

		}

   114

	}

   115

	return NULL;

   116

}

   117

   118

/**

   119

 * Unload all wagon override sprite groups.

   120

 */

   121

void UnloadWagonOverrides(void)

   122

{

   123

	WagonOverrides *wos;

   124

	WagonOverride *wo;

   125

	EngineID engine;

   126

	int i;

   127

   128

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

   129

		wos = &_engine_wagon_overrides[engine];

   130

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

   131

			wo = &wos->overrides[i];

   132

			wo->group = NULL;

   133

			free(wo->train_id);

   134

		}

   135

		free(wos->overrides);

   136

		wos->overrides_count = 0;

   137

		wos->overrides = NULL;

   138

	}

   139

}

   140

   141

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

   142

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

   143

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

   144

// memory. --pasky)

   145

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

   146

static const GRFFile *_engine_grf[TOTAL_NUM_ENGINES];

   147

   148

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

   149

{

   150

	assert(engine < TOTAL_NUM_ENGINES);

   151

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

   152

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

   153

	}

   154

	engine_custom_sprites[engine][cargo] = group;

   155

}

   156

   157

/**

   158

 * Unload all engine sprite groups.

   159

 */

   160

void UnloadCustomEngineSprites(void)

   161

{

   162

	EngineID engine;

   163

	CargoID cargo;

   164

   165

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

   166

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

   167

			engine_custom_sprites[engine][cargo] = NULL;

   168

		}

   169

		_engine_grf[engine] = 0;

   170

	}

   171

}

   172

   173

static const SpriteGroup *heli_rotor_custom_sprites[NUM_AIRCRAFT_ENGINES];

   174

   175

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

   176

void SetRotorOverrideSprites(EngineID engine, const SpriteGroup *group)

   177

{

   178

	assert(engine >= AIRCRAFT_ENGINES_INDEX);

   179

	assert(engine < AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES);

   180

   181

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

   182

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

   183

	}

   184

	heli_rotor_custom_sprites[engine - AIRCRAFT_ENGINES_INDEX] = group;

   185

}

   186

   187

/** Unload all rotor override sprite groups */

   188

void UnloadRotorOverrideSprites(void)

   189

{

   190

	EngineID engine;

   191

   192

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

   193

	 * the context of EngineID is correct */

   194

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

   195

		heli_rotor_custom_sprites[engine - AIRCRAFT_ENGINES_INDEX] = NULL;

   196

	}

   197

}

   198

   199

   200

/**

   201

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

   202

 * etc during a game.

   203

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

   204

 * @param file   Pointer of GRFFile to tie.

   205

 */

   206

void SetEngineGRF(EngineID engine, const GRFFile *file)

   207

{

   208

	assert(engine < TOTAL_NUM_ENGINES);

   209

	_engine_grf[engine] = file;

   210

}

   211

   212

   213

/**

   214

 * Retrieve the GRFFile tied to an engine

   215

 * @param engine Engine ID to retrieve.

   216

 * @return Pointer to GRFFile.

   217

 */

   218

const GRFFile *GetEngineGRF(EngineID engine)

   219

{

   220

	assert(engine < TOTAL_NUM_ENGINES);

   221

	return _engine_grf[engine];

   222

}

   223

   224

   225

/**

   226

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

   227

 * @param engine Engine ID to retrieve.

   228

 * @return 32 bit GRFID value.

   229

 */

   230

uint32 GetEngineGRFID(EngineID engine)

   231

{

   232

	assert(engine < TOTAL_NUM_ENGINES);

   233

	return _engine_grf[engine]->grfid;

   234

}

   235

   236

   237

static int MapOldSubType(const Vehicle *v)

   238

{

   239

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

   240

	if (IsTrainEngine(v)) return 0;

   241

	if (IsFreeWagon(v)) return 4;

   242

	return 2;

   243

}

   244

   245

   246

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

   247

enum {

   248

	AMS_TTDP_HANGAR,

   249

	AMS_TTDP_TO_HANGAR,

   250

	AMS_TTDP_TO_PAD1,

   251

	AMS_TTDP_TO_PAD2,

   252

	AMS_TTDP_TO_PAD3,

   253

	AMS_TTDP_TO_ENTRY_2_AND_3,

   254

	AMS_TTDP_TO_ENTRY_2_AND_3_AND_H,

   255

	AMS_TTDP_TO_JUNCTION,

   256

	AMS_TTDP_LEAVE_RUNWAY,

   257

	AMS_TTDP_TO_INWAY,

   258

	AMS_TTDP_TO_RUNWAY,

   259

	AMS_TTDP_TO_OUTWAY,

   260

	AMS_TTDP_WAITING,

   261

	AMS_TTDP_TAKEOFF,

   262

	AMS_TTDP_TO_TAKEOFF,

   263

	AMS_TTDP_CLIMBING,

   264

	AMS_TTDP_FLIGHT_APPROACH,

   265

	AMS_TTDP_UNUSED_0x11,

   266

	AMS_TTDP_FLIGHT_TO_TOWER,

   267

	AMS_TTDP_UNUSED_0x13,

   268

	AMS_TTDP_FLIGHT_FINAL,

   269

	AMS_TTDP_FLIGHT_DESCENT,

   270

	AMS_TTDP_BRAKING,

   271

	AMS_TTDP_HELI_TAKEOFF_AIRPORT,

   272

	AMS_TTDP_HELI_TO_TAKEOFF_AIRPORT,

   273

	AMS_TTDP_HELI_LAND_AIRPORT,

   274

	AMS_TTDP_HELI_TAKEOFF_HELIPORT,

   275

	AMS_TTDP_HELI_TO_TAKEOFF_HELIPORT,

   276

	AMS_TTDP_HELI_LAND_HELIPORT,

   277

};

   278

   279

   280

/**

   281

 * Map OTTD aircraft movement states to TTDPatch style movement states

   282

 * (VarAction 2 Variable 0xE2)

   283

 */

   284

static byte MapAircraftMovementState(const Vehicle *v)

   285

{

   286

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

   287

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

   288

   289

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

   290

		case HANGAR:

   291

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

   292

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

   293

			 * AMED_HELI_LOWER some time before actually descending. */

   294

   295

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

   296

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

   297

			if (amdflag & AMED_HELI_LOWER) return AMS_TTDP_HELI_LAND_AIRPORT;

   298

   299

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

   300

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

   301

			if (amdflag & AMED_SLOWTURN) return AMS_TTDP_FLIGHT_TO_TOWER;

   302

   303

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

   304

			/* Has reached hanger? */

   305

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_HANGAR;

   306

   307

			// Still moving towards hanger.

   308

			return AMS_TTDP_TO_HANGAR;

   309

   310

		case TERM1:

   311

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD1;

   312

			return AMS_TTDP_TO_JUNCTION;

   313

   314

		case TERM2:

   315

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD2;

   316

			return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H;

   317

   318

		case TERM3:

   319

		case TERM4:

   320

		case TERM5:

   321

		case TERM6:

   322

		case TERM7:

   323

		case TERM8:

   324

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

   325

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD3;

   326

			return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H;

   327

   328

		case HELIPAD1:

   329

		case HELIPAD2:

   330

		case HELIPAD3:

   331

		case HELIPAD4: // Will only occur for helicopters.

   332

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

   333

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

   334

			return AMS_TTDP_TO_JUNCTION; // On the ground.

   335

   336

		case TAKEOFF: // Moving to takeoff position.

   337

			return AMS_TTDP_TO_OUTWAY;

   338

   339

		case STARTTAKEOFF: // Accelerating down runway.

   340

			return AMS_TTDP_TAKEOFF;

   341

   342

		case ENDTAKEOFF: // Ascent

   343

			return AMS_TTDP_CLIMBING;

   344

   345

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

   346

			switch (st->airport_type) {

   347

				case AT_SMALL:

   348

				case AT_LARGE:

   349

				case AT_METROPOLITAN:

   350

				case AT_INTERNATIONAL:

   351

				case AT_COMMUTER:

   352

				case AT_INTERCON:

   353

				/* Note, Helidepot and Helistation are treated as airports as

   354

				 * helicopters are taking off from ground level. */

   355

				case AT_HELIDEPOT:

   356

				case AT_HELISTATION:

   357

					if (amdflag & AMED_HELI_RAISE) return AMS_TTDP_HELI_TAKEOFF_AIRPORT;

   358

					return AMS_TTDP_TO_JUNCTION;

   359

   360

				case AT_HELIPORT:

   361

				case AT_OILRIG:

   362

					return AMS_TTDP_HELI_TAKEOFF_HELIPORT;

   363

   364

				default:

   365

					return AMS_TTDP_HELI_TAKEOFF_AIRPORT;

   366

			}

   367

   368

		case FLYING:

   369

			return AMS_TTDP_FLIGHT_TO_TOWER;

   370

   371

		case LANDING: // Descent

   372

			return AMS_TTDP_FLIGHT_DESCENT;

   373

   374

		case ENDLANDING: // On the runway braking

   375

			if (amdflag & AMED_BRAKE) return AMS_TTDP_BRAKING;

   376

			// Landed - moving off runway

   377

			return AMS_TTDP_TO_INWAY;

   378

   379

		case HELILANDING:

   380

		case HELIENDLANDING: // Helicoptor is decending.

   381

			if (amdflag & AMED_HELI_LOWER) {

   382

				switch (st->airport_type) {

   383

					case AT_HELIPORT:

   384

					case AT_OILRIG:

   385

						return AMS_TTDP_HELI_LAND_HELIPORT;

   386

   387

					default:

   388

						/* Note, Helidepot and Helistation are treated as airports as

   389

						 * helicopters are landing at ground level. */

   390

						return AMS_TTDP_HELI_LAND_AIRPORT;

   391

				}

   392

			}

   393

			return AMS_TTDP_FLIGHT_TO_TOWER;

   394

   395

		default:

   396

			return AMS_TTDP_HANGAR;

   397

	}

   398

}

   399

   400

   401

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

   402

enum {

   403

	AMA_TTDP_IN_HANGAR,

   404

	AMA_TTDP_ON_PAD1,

   405

	AMA_TTDP_ON_PAD2,

   406

	AMA_TTDP_ON_PAD3,

   407

	AMA_TTDP_HANGAR_TO_PAD1,

   408

	AMA_TTDP_HANGAR_TO_PAD2,

   409

	AMA_TTDP_HANGAR_TO_PAD3,

   410

	AMA_TTDP_LANDING_TO_PAD1,

   411

	AMA_TTDP_LANDING_TO_PAD2,

   412

	AMA_TTDP_LANDING_TO_PAD3,

   413

	AMA_TTDP_PAD1_TO_HANGAR,

   414

	AMA_TTDP_PAD2_TO_HANGAR,

   415

	AMA_TTDP_PAD3_TO_HANGAR,

   416

	AMA_TTDP_PAD1_TO_TAKEOFF,

   417

	AMA_TTDP_PAD2_TO_TAKEOFF,

   418

	AMA_TTDP_PAD3_TO_TAKEOFF,

   419

	AMA_TTDP_HANGAR_TO_TAKOFF,

   420

	AMA_TTDP_LANDING_TO_HANGAR,

   421

	AMA_TTDP_IN_FLIGHT,

   422

};

   423

   424

   425

/**

   426

 * Map OTTD aircraft movement states to TTDPatch style movement actions

   427

 * (VarAction 2 Variable 0xE6)

   428

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

   429

 */

   430

static byte MapAircraftMovementAction(const Vehicle *v)

   431

{

   432

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

   433

		case HANGAR:

   434

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

   435

   436

		case TERM1:

   437

		case HELIPAD1:

   438

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

   439

   440

		case TERM2:

   441

		case HELIPAD2:

   442

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

   443

   444

		case TERM3:

   445

		case TERM4:

   446

		case TERM5:

   447

		case TERM6:

   448

		case TERM7:

   449

		case TERM8:

   450

		case HELIPAD3:

   451

		case HELIPAD4:

   452

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

   453

   454

		case TAKEOFF:      // Moving to takeoff position

   455

		case STARTTAKEOFF: // Accelerating down runway

   456

		case ENDTAKEOFF:   // Ascent

   457

		case HELITAKEOFF:

   458

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

   459

			return AMA_TTDP_PAD1_TO_TAKEOFF;

   460

   461

		case FLYING:

   462

			return AMA_TTDP_IN_FLIGHT;

   463

   464

		case LANDING:    // Descent

   465

		case ENDLANDING: // On the runway braking

   466

		case HELILANDING:

   467

		case HELIENDLANDING:

   468

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

   469

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

   470

				AMA_TTDP_LANDING_TO_HANGAR : AMA_TTDP_LANDING_TO_PAD1;

   471

   472

		default:

   473

			return AMA_TTDP_IN_HANGAR;

   474

	}

   475

}

   476

   477

   478

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

   479

enum {

   480

	ATP_TTDP_SMALL,

   481

	ATP_TTDP_LARGE,

   482

	ATP_TTDP_HELIPORT,

   483

	ATP_TTDP_OILRIG,

   484

};

   485

   486

   487

/* Vehicle Resolver Functions */

   488

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

   489

{

   490

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

   491

}