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

typedef struct WagonOverride {

    62

	byte *train_id;

    63

	int trains;

    64

	CargoID cargo;

    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, CargoID cargo, const SpriteGroup *group, byte *train_id, int trains)

    76

{

    77

	WagonOverrides *wos;

    78

	WagonOverride *wo;

    79

    80

	assert(engine < TOTAL_NUM_ENGINES);

    81

	assert(cargo < NUM_GLOBAL_CID);

    82

    83

	wos = &_engine_wagon_overrides[engine];

    84

	wos->overrides_count++;

    85

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

    86

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

    87

    88

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

    89

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

    90

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

    91

	 * --pasky */

    92

	wo->group = group;

    93

	wo->cargo = cargo;

    94

	wo->trains = trains;

    95

	wo->train_id = malloc(trains);

    96

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

    97

}

    98

    99

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

   100

{

   101

	const WagonOverrides *wos = &_engine_wagon_overrides[engine];

   102

	int i;

   103

   104

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

   105

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

   106

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

   107

	// that. --pasky

   108

   109

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

   110

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

   111

		int j;

   112

   113

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

   114

			if (wo->train_id[j] == overriding_engine && (wo->cargo == cargo || wo->cargo == GC_DEFAULT)) return wo->group;

   115

		}

   116

	}

   117

	return NULL;

   118

}

   119

   120

/**

   121

 * Unload all wagon override sprite groups.

   122

 */

   123

void UnloadWagonOverrides(void)

   124

{

   125

	WagonOverrides *wos;

   126

	WagonOverride *wo;

   127

	EngineID engine;

   128

	int i;

   129

   130

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

   131

		wos = &_engine_wagon_overrides[engine];

   132

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

   133

			wo = &wos->overrides[i];

   134

			wo->group = NULL;

   135

			free(wo->train_id);

   136

		}

   137

		free(wos->overrides);

   138

		wos->overrides_count = 0;

   139

		wos->overrides = NULL;

   140

	}

   141

}

   142

   143

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

   144

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

   145

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

   146

// memory. --pasky)

   147

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

   148

static const GRFFile *_engine_grf[TOTAL_NUM_ENGINES];

   149

   150

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

   151

{

   152

	assert(engine < TOTAL_NUM_ENGINES);

   153

	assert(cargo < NUM_GLOBAL_CID);

   154

   155

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

   156

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

   157

	}

   158

	engine_custom_sprites[engine][cargo] = group;

   159

}

   160

   161

/**

   162

 * Unload all engine sprite groups.

   163

 */

   164

void UnloadCustomEngineSprites(void)

   165

{

   166

	EngineID engine;

   167

	CargoID cargo;

   168

   169

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

   170

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

   171

			engine_custom_sprites[engine][cargo] = NULL;

   172

		}

   173

		_engine_grf[engine] = 0;

   174

	}

   175

}

   176

   177

static const SpriteGroup *heli_rotor_custom_sprites[NUM_AIRCRAFT_ENGINES];

   178

   179

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

   180

void SetRotorOverrideSprites(EngineID engine, const SpriteGroup *group)

   181

{

   182

	assert(engine >= AIRCRAFT_ENGINES_INDEX);

   183

	assert(engine < AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES);

   184

   185

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

   186

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

   187

	}

   188

	heli_rotor_custom_sprites[engine - AIRCRAFT_ENGINES_INDEX] = group;

   189

}

   190

   191

/** Unload all rotor override sprite groups */

   192

void UnloadRotorOverrideSprites(void)

   193

{

   194

	EngineID engine;

   195

   196

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

   197

	 * the context of EngineID is correct */

   198

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

   199

		heli_rotor_custom_sprites[engine - AIRCRAFT_ENGINES_INDEX] = NULL;

   200

	}

   201

}

   202

   203

   204

/**

   205

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

   206

 * etc during a game.

   207

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

   208

 * @param file   Pointer of GRFFile to tie.

   209

 */

   210

void SetEngineGRF(EngineID engine, const GRFFile *file)

   211

{

   212

	assert(engine < TOTAL_NUM_ENGINES);

   213

	_engine_grf[engine] = file;

   214

}

   215

   216

   217

/**

   218

 * Retrieve the GRFFile tied to an engine

   219

 * @param engine Engine ID to retrieve.

   220

 * @return Pointer to GRFFile.

   221

 */

   222

const GRFFile *GetEngineGRF(EngineID engine)

   223

{

   224

	assert(engine < TOTAL_NUM_ENGINES);

   225

	return _engine_grf[engine];

   226

}

   227

   228

   229

/**

   230

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

   231

 * @param engine Engine ID to retrieve.

   232

 * @return 32 bit GRFID value.

   233

 */

   234

uint32 GetEngineGRFID(EngineID engine)

   235

{

   236

	assert(engine < TOTAL_NUM_ENGINES);

   237

	return _engine_grf[engine]->grfid;

   238

}

   239

   240

   241

static int MapOldSubType(const Vehicle *v)

   242

{

   243

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

   244

	if (IsTrainEngine(v)) return 0;

   245

	if (IsFreeWagon(v)) return 4;

   246

	return 2;

   247

}

   248

   249

   250

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

   251

enum {

   252

	AMS_TTDP_HANGAR,

   253

	AMS_TTDP_TO_HANGAR,

   254

	AMS_TTDP_TO_PAD1,

   255

	AMS_TTDP_TO_PAD2,

   256

	AMS_TTDP_TO_PAD3,

   257

	AMS_TTDP_TO_ENTRY_2_AND_3,

   258

	AMS_TTDP_TO_ENTRY_2_AND_3_AND_H,

   259

	AMS_TTDP_TO_JUNCTION,

   260

	AMS_TTDP_LEAVE_RUNWAY,

   261

	AMS_TTDP_TO_INWAY,

   262

	AMS_TTDP_TO_RUNWAY,

   263

	AMS_TTDP_TO_OUTWAY,

   264

	AMS_TTDP_WAITING,

   265

	AMS_TTDP_TAKEOFF,

   266

	AMS_TTDP_TO_TAKEOFF,

   267

	AMS_TTDP_CLIMBING,

   268

	AMS_TTDP_FLIGHT_APPROACH,

   269

	AMS_TTDP_UNUSED_0x11,

   270

	AMS_TTDP_FLIGHT_TO_TOWER,

   271

	AMS_TTDP_UNUSED_0x13,

   272

	AMS_TTDP_FLIGHT_FINAL,

   273

	AMS_TTDP_FLIGHT_DESCENT,

   274

	AMS_TTDP_BRAKING,

   275

	AMS_TTDP_HELI_TAKEOFF_AIRPORT,

   276

	AMS_TTDP_HELI_TO_TAKEOFF_AIRPORT,

   277

	AMS_TTDP_HELI_LAND_AIRPORT,

   278

	AMS_TTDP_HELI_TAKEOFF_HELIPORT,

   279

	AMS_TTDP_HELI_TO_TAKEOFF_HELIPORT,

   280

	AMS_TTDP_HELI_LAND_HELIPORT,

   281

};

   282

   283

   284

/**

   285

 * Map OTTD aircraft movement states to TTDPatch style movement states

   286

 * (VarAction 2 Variable 0xE2)

   287

 */

   288

static byte MapAircraftMovementState(const Vehicle *v)

   289

{

   290

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

   291

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

   292

   293

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

   294

   295

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

   296

		case HANGAR:

   297

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

   298

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

   299

			 * AMED_HELI_LOWER some time before actually descending. */

   300

   301

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

   302

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

   303

			if (amdflag & AMED_HELI_LOWER) return AMS_TTDP_HELI_LAND_AIRPORT;

   304

   305

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

   306

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

   307

			if (amdflag & AMED_SLOWTURN) return AMS_TTDP_FLIGHT_TO_TOWER;

   308

   309

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

   310

			/* Has reached hanger? */

   311

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_HANGAR;

   312

   313

			// Still moving towards hanger.

   314

			return AMS_TTDP_TO_HANGAR;

   315

   316

		case TERM1:

   317

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD1;

   318

			return AMS_TTDP_TO_JUNCTION;

   319

   320

		case TERM2:

   321

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD2;

   322

			return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H;

   323

   324

		case TERM3:

   325

		case TERM4:

   326

		case TERM5:

   327

		case TERM6:

   328

		case TERM7:

   329

		case TERM8:

   330

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

   331

			if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD3;

   332

			return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H;

   333

   334

		case HELIPAD1:

   335

		case HELIPAD2:

   336

		case HELIPAD3:

   337

		case HELIPAD4: // Will only occur for helicopters.

   338

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

   339

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

   340

			return AMS_TTDP_TO_JUNCTION; // On the ground.

   341

   342

		case TAKEOFF: // Moving to takeoff position.

   343

			return AMS_TTDP_TO_OUTWAY;

   344

   345

		case STARTTAKEOFF: // Accelerating down runway.

   346

			return AMS_TTDP_TAKEOFF;

   347

   348

		case ENDTAKEOFF: // Ascent

   349

			return AMS_TTDP_CLIMBING;

   350

   351

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

   352

			switch (st->airport_type) {

   353

				case AT_SMALL:

   354

				case AT_LARGE:

   355

				case AT_METROPOLITAN:

   356

				case AT_INTERNATIONAL:

   357

				case AT_COMMUTER:

   358

				case AT_INTERCON:

   359

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

   360

				 * helicopters are taking off from ground level. */

   361

				case AT_HELIDEPOT:

   362

				case AT_HELISTATION:

   363

					if (amdflag & AMED_HELI_RAISE) return AMS_TTDP_HELI_TAKEOFF_AIRPORT;

   364

					return AMS_TTDP_TO_JUNCTION;

   365

   366

				case AT_HELIPORT:

   367

				case AT_OILRIG:

   368

					return AMS_TTDP_HELI_TAKEOFF_HELIPORT;

   369

   370

				default:

   371

					return AMS_TTDP_HELI_TAKEOFF_AIRPORT;

   372

			}

   373

   374

		case FLYING:

   375

			return AMS_TTDP_FLIGHT_TO_TOWER;

   376

   377

		case LANDING: // Descent

   378

			return AMS_TTDP_FLIGHT_DESCENT;

   379

   380

		case ENDLANDING: // On the runway braking

   381

			if (amdflag & AMED_BRAKE) return AMS_TTDP_BRAKING;

   382

			// Landed - moving off runway

   383

			return AMS_TTDP_TO_INWAY;

   384

   385

		case HELILANDING:

   386

		case HELIENDLANDING: // Helicoptor is decending.

   387

			if (amdflag & AMED_HELI_LOWER) {

   388

				switch (st->airport_type) {

   389

					case AT_HELIPORT:

   390

					case AT_OILRIG:

   391

						return AMS_TTDP_HELI_LAND_HELIPORT;

   392

   393

					default:

   394

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

   395

						 * helicopters are landing at ground level. */

   396

						return AMS_TTDP_HELI_LAND_AIRPORT;

   397

				}

   398

			}

   399

			return AMS_TTDP_FLIGHT_TO_TOWER;

   400

   401

		default:

   402

			return AMS_TTDP_HANGAR;

   403

	}

   404

}

   405

   406

   407

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

   408

enum {

   409

	AMA_TTDP_IN_HANGAR,

   410

	AMA_TTDP_ON_PAD1,

   411

	AMA_TTDP_ON_PAD2,

   412

	AMA_TTDP_ON_PAD3,

   413

	AMA_TTDP_HANGAR_TO_PAD1,

   414

	AMA_TTDP_HANGAR_TO_PAD2,

   415

	AMA_TTDP_HANGAR_TO_PAD3,

   416

	AMA_TTDP_LANDING_TO_PAD1,

   417

	AMA_TTDP_LANDING_TO_PAD2,

   418

	AMA_TTDP_LANDING_TO_PAD3,

   419

	AMA_TTDP_PAD1_TO_HANGAR,

   420

	AMA_TTDP_PAD2_TO_HANGAR,

   421

	AMA_TTDP_PAD3_TO_HANGAR,

   422

	AMA_TTDP_PAD1_TO_TAKEOFF,

   423

	AMA_TTDP_PAD2_TO_TAKEOFF,

   424

	AMA_TTDP_PAD3_TO_TAKEOFF,

   425

	AMA_TTDP_HANGAR_TO_TAKOFF,

   426

	AMA_TTDP_LANDING_TO_HANGAR,

   427

	AMA_TTDP_IN_FLIGHT,

   428

};

   429

   430

   431

/**

   432

 * Map OTTD aircraft movement states to TTDPatch style movement actions

   433

 * (VarAction 2 Variable 0xE6)

   434

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

   435

 */

   436

static byte MapAircraftMovementAction(const Vehicle *v)

   437

{

   438

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

   439

		case HANGAR:

   440

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

   441

   442

		case TERM1:

   443

		case HELIPAD1:

   444

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

   445

   446

		case TERM2:

   447

		case HELIPAD2:

   448

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

   449

   450

		case TERM3:

   451

		case TERM4:

   452

		case TERM5:

   453

		case TERM6:

   454

		case TERM7:

   455

		case TERM8:

   456

		case HELIPAD3:

   457

		case HELIPAD4:

   458

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

   459

   460

		case TAKEOFF:      // Moving to takeoff position

   461

		case STARTTAKEOFF: // Accelerating down runway

   462

		case ENDTAKEOFF:   // Ascent

   463

		case HELITAKEOFF:

   464

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

   465

			return AMA_TTDP_PAD1_TO_TAKEOFF;

   466

   467

		case FLYING:

   468

			return AMA_TTDP_IN_FLIGHT;

   469

   470

		case LANDING:    // Descent

   471

		case ENDLANDING: // On the runway braking

   472

		case HELILANDING:

   473

		case HELIENDLANDING:

   474

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

   475

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

   476

				AMA_TTDP_LANDING_TO_HANGAR : AMA_TTDP_LANDING_TO_PAD1;

   477

   478

		default:

   479

			return AMA_TTDP_IN_HANGAR;

   480

	}

   481

}

   482

   483

   484

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

   485

enum {

   486

	ATP_TTDP_SMALL,

   487

	ATP_TTDP_LARGE,

   488

	ATP_TTDP_HELIPORT,

   489

	ATP_TTDP_OILRIG,

   490

};

   491