1

/* $Id$ */

     2

     3

#ifndef ENGINE_H

     4

#define ENGINE_H

     5

     6

/** @file engine.h

     7

  */

     8

     9

#include "sprite.h"

    10

#include "pool.h"

    11

    12

typedef struct RailVehicleInfo {

    13

	byte image_index;

    14

	byte flags; /* 1=multihead engine, 2=wagon */

    15

	byte base_cost;

    16

	uint16 max_speed;

    17

	uint16 power;

    18

	uint16 weight;

    19

	byte running_cost_base;

    20

	byte running_cost_class;

    21

	byte engclass; // 0: steam, 1: diesel, 2: electric

    22

	byte capacity;

    23

	byte cargo_type;

    24

	byte callbackmask; // see CallbackMask enum

    25

	uint16 pow_wag_power;

    26

	byte pow_wag_weight;

    27

	byte visual_effect; // NOTE: this is not 100% implemented yet, at the moment it is only used as a 'fallback' value

    28

	                    //       for when the 'powered wagon' callback fails. But it should really also determine what

    29

	                    //       kind of visual effect to generate for a vehicle (default, steam, diesel, electric).

    30

	                    //       Same goes for the callback result, which atm is only used to check if a wagon is powered.

    31

	byte shorten_factor;	// length on main map for this type is 8 - shorten_factor

    32

} RailVehicleInfo;

    33

    34

typedef struct ShipVehicleInfo {

    35

	byte image_index;

    36

	byte base_cost;

    37

	uint16 max_speed;

    38

	byte cargo_type;

    39

	uint16 capacity;

    40

	byte running_cost;

    41

	byte sfx;

    42

	byte refittable;

    43

} ShipVehicleInfo;

    44

    45

typedef struct AircraftVehicleInfo {

    46

	byte image_index;

    47

	byte base_cost;

    48

	byte running_cost;

    49

	byte subtype;

    50

	byte sfx;

    51

	byte acceleration;

    52

	byte max_speed;

    53

	byte mail_capacity;

    54

	uint16 passenger_capacity;

    55

} AircraftVehicleInfo;

    56

    57

typedef struct RoadVehicleInfo {

    58

	byte image_index;

    59

	byte base_cost;

    60

	byte running_cost;

    61

	byte sfx;

    62

	byte max_speed;

    63

	byte capacity;

    64

	byte cargo_type;

    65

} RoadVehicleInfo;

    66

    67

/** Information about a vehicle

    68

  * @see table/engines.h

    69

  */

    70

typedef struct EngineInfo {

    71

	uint16 base_intro;

    72

	byte unk2;              ///< Carriages have the highest bit set in this one

    73

	byte lifelength;

    74

	byte base_life;

    75

	byte railtype:4;

    76

	byte climates:4;

    77

	uint32 refit_mask;

    78

} EngineInfo;

    79

    80

typedef struct Engine {

    81

	uint16 intro_date;

    82

	uint16 age;

    83

	uint16 reliability;

    84

	uint16 reliability_spd_dec;

    85

	uint16 reliability_start, reliability_max, reliability_final;

    86

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

    87

	byte lifelength;

    88

	byte flags;

    89

	byte preview_player;

    90

	byte preview_wait;

    91

	byte railtype;

    92

	byte player_avail;

    93

	byte type;				// type, ie VEH_Road, VEH_Train, etc. Same as in vehicle.h

    94

} Engine;

    95

    96

    97

enum {

    98

	RVI_MULTIHEAD = 1,

    99

	RVI_WAGON = 2,

   100

};

   101

   102

enum {

   103

	NUM_VEHICLE_TYPES = 6

   104

};

   105

   106

enum {

   107

	INVALID_ENGINE = 0xFFFF,

   108

};

   109

   110

void AddTypeToEngines(void);

   111

void StartupEngines(void);

   112

   113

enum GlobalCargo {

   114

	GC_PASSENGERS   =   0,

   115

	GC_COAL         =   1,

   116

	GC_MAIL         =   2,

   117

	GC_OIL          =   3,

   118

	GC_LIVESTOCK    =   4,

   119

	GC_GOODS        =   5,

   120

	GC_GRAIN        =   6, // GC_WHEAT / GC_MAIZE

   121

	GC_WOOD         =   7,

   122

	GC_IRON_ORE     =   8,

   123

	GC_STEEL        =   9,

   124

	GC_VALUABLES    =  10, // GC_GOLD / GC_DIAMONDS

   125

	GC_PAPER        =  11,

   126

	GC_FOOD         =  12,

   127

	GC_FRUIT        =  13,

   128

	GC_COPPER_ORE   =  14,

   129

	GC_WATER        =  15,

   130

	GC_RUBBER       =  16,

   131

	GC_SUGAR        =  17,

   132

	GC_TOYS         =  18,

   133

	GC_BATTERIES    =  19,

   134

	GC_CANDY        =  20,

   135

	GC_TOFFEE       =  21,

   136

	GC_COLA         =  22,

   137

	GC_COTTON_CANDY =  23,

   138

	GC_BUBBLES      =  24,

   139

	GC_PLASTIC      =  25,

   140

	GC_FIZZY_DRINKS =  26,

   141

	GC_PAPER_TEMP   =  27,

   142

	GC_UNDEFINED    =  28, // undefined; unused slot in arctic climate

   143

	GC_DEFAULT      =  29,

   144

	GC_PURCHASE     =  30,

   145

	GC_INVALID      = 255,

   146

	NUM_GLOBAL_CID  =  31

   147

};

   148

   149

// This enum lists the implemented callbacks

   150

// Use as argument for the GetCallBackResult function (see comments there)

   151

enum CallbackID {

   152

	// Powered wagons, if the result is lower as 0x40 then the wagon is powered

   153

	// TODO: interpret the rest of the result, aka "visual effects"

   154

	CBID_WAGON_POWER = 0x10,

   155

   156

	// Vehicle length, returns the amount of 1/8's the vehicle is shorter

   157

	// only for train vehicles

   158

	CBID_VEH_LENGTH = 0x11,

   159

   160

	// Refit capacity, the passed vehicle needs to have its ->cargo_type set to

   161

	// the cargo we are refitting to, returns the new cargo capacity

   162

	CBID_REFIT_CAP = 0x15,

   163

   164

	CBID_ARTIC_ENGINE = 0x16,

   165

};

   166

   167

// bit positions for rvi->callbackmask, indicates which callbacks are used by an engine

   168

// (some callbacks are always used, and dont appear here)

   169

enum CallbackMask {

   170

	CBM_WAGON_POWER = 0,

   171

	CBM_VEH_LENGTH = 1,

   172

	CBM_REFIT_CAP = 3,

   173

	CBM_ARTIC_ENGINE = 4,

   174

};

   175

   176

enum {

   177

	CALLBACK_FAILED = 0xFFFF

   178

};

   179

   180

VARDEF const uint32 _default_refitmasks[NUM_VEHICLE_TYPES];

   181

VARDEF const CargoID _global_cargo_id[NUM_LANDSCAPE][NUM_CARGO];

   182

VARDEF const uint32 _landscape_global_cargo_mask[NUM_LANDSCAPE];

   183

VARDEF const CargoID _local_cargo_id_ctype[NUM_GLOBAL_CID];

   184

VARDEF const uint32 cargo_classes[16];

   185

   186

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

   187

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

   188

// loaded is in percents, overriding_engine 0xffff is none

   189

int GetCustomEngineSprite(EngineID engine, const Vehicle *v, byte direction);

   190

uint16 GetCallBackResult(uint16 callback_info, EngineID engine, const Vehicle *v);

   191

bool UsesWagonOverride(const Vehicle *v);

   192

#define GetCustomVehicleSprite(v, direction) GetCustomEngineSprite(v->engine_type, v, direction)

   193

#define GetCustomVehicleIcon(et, direction) GetCustomEngineSprite(et, NULL, direction)

   194

   195

typedef enum VehicleTrigger {

   196

	VEHICLE_TRIGGER_NEW_CARGO = 1,

   197

	// Externally triggered only for the first vehicle in chain

   198

	VEHICLE_TRIGGER_DEPOT = 2,

   199

	// Externally triggered only for the first vehicle in chain, only if whole chain is empty

   200

	VEHICLE_TRIGGER_EMPTY = 4,

   201

	// Not triggered externally (called for the whole chain if we got NEW_CARGO)

   202

	VEHICLE_TRIGGER_ANY_NEW_CARGO = 8,

   203

} VehicleTrigger;

   204

void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);

   205

   206

void SetCustomEngineName(EngineID engine, const char *name);

   207

StringID GetCustomEngineName(EngineID engine);

   208

   209

   210

void DrawTrainEngine(int x, int y, EngineID engine, uint32 image_ormod);

   211

void DrawRoadVehEngine(int x, int y, EngineID engine, uint32 image_ormod);

   212

void DrawShipEngine(int x, int y, EngineID engine, uint32 image_ormod);

   213

void DrawAircraftEngine(int x, int y, EngineID engine, uint32 image_ormod);

   214

   215

void LoadCustomEngineNames(void);

   216

void DeleteCustomEngineNames(void);

   217

   218

bool IsEngineBuildable(uint engine, byte type);

   219

   220

enum {

   221

	NUM_NORMAL_RAIL_ENGINES = 54,

   222

	NUM_MONORAIL_ENGINES = 30,

   223

	NUM_MAGLEV_ENGINES = 32,

   224

	NUM_TRAIN_ENGINES = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   225

	NUM_ROAD_ENGINES = 88,

   226

	NUM_SHIP_ENGINES = 11,

   227

	NUM_AIRCRAFT_ENGINES = 41,

   228

	TOTAL_NUM_ENGINES = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   229

	AIRCRAFT_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   230

	SHIP_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   231

	ROAD_ENGINES_INDEX = NUM_TRAIN_ENGINES,

   232

};

   233

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   234

#define FOR_ALL_ENGINES(e) for (e = _engines; e != endof(_engines); e++)

   235

   236

static inline Engine* GetEngine(EngineID i)

   237

{

   238

  assert(i < lengthof(_engines));

   239

  return &_engines[i];

   240

}

   241

   242

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   243

   244

static inline bool IsEngineIndex(uint index)

   245

{

   246

	return index < TOTAL_NUM_ENGINES;

   247

}

   248

   249

/* Access Vehicle Data */

   250

//#include "table/engines.h"

   251

extern const EngineInfo orig_engine_info[TOTAL_NUM_ENGINES];

   252

extern const RailVehicleInfo orig_rail_vehicle_info[NUM_TRAIN_ENGINES];

   253

extern const ShipVehicleInfo orig_ship_vehicle_info[NUM_SHIP_ENGINES];

   254

extern const AircraftVehicleInfo orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   255

extern const RoadVehicleInfo orig_road_vehicle_info[NUM_ROAD_ENGINES];

   256

   257

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   258

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   259

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   260

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   261

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   262

   263

static inline const RailVehicleInfo* RailVehInfo(EngineID e)

   264

{

   265

	assert(e < lengthof(_rail_vehicle_info));

   266

	return &_rail_vehicle_info[e];

   267

}

   268

   269

static inline const ShipVehicleInfo* ShipVehInfo(EngineID e)

   270

{

   271

	assert(e >= SHIP_ENGINES_INDEX && e < SHIP_ENGINES_INDEX + lengthof(_ship_vehicle_info));

   272

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   273

}

   274

   275

static inline const AircraftVehicleInfo* AircraftVehInfo(EngineID e)

   276

{

   277

	assert(e >= AIRCRAFT_ENGINES_INDEX && e < AIRCRAFT_ENGINES_INDEX + lengthof(_aircraft_vehicle_info));

   278

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   279

}

   280

   281

static inline const RoadVehicleInfo* RoadVehInfo(EngineID e)

   282

{

   283

	assert(e >= ROAD_ENGINES_INDEX && e < ROAD_ENGINES_INDEX + lengthof(_road_vehicle_info));

   284

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   285

}

   286

   287

void UnloadWagonOverrides(void);

   288

void UnloadCustomEngineSprites(void);

   289

void UnloadCustomEngineNames(void);

   290

   291

/************************************************************************

   292

 * Engine Replacement stuff

   293

 ************************************************************************/

   294

   295

/**

   296

 * Struct to store engine replacements. DO NOT USE outside of engine.c. Is

   297

 * placed here so the only exception to this rule, the saveload code, can use

   298

 * it.

   299

 */

   300

struct EngineRenew {

   301

	uint16 index;

   302

	EngineID from;

   303

	EngineID to;

   304

	struct EngineRenew *next;

   305

};

   306

   307

typedef struct EngineRenew EngineRenew;

   308

   309

/**

   310

 * Memory pool for engine renew elements. DO NOT USE outside of engine.c. Is

   311

 * placed here so the only exception to this rule, the saveload code, can use

   312

 * it.

   313

 */

   314

extern MemoryPool _engine_renew_pool;

   315

   316

/**

   317

 * DO NOT USE outside of engine.c. Is

   318

 * placed here so the only exception to this rule, the saveload code, can use

   319

 * it.

   320

 */

   321

static inline EngineRenew *GetEngineRenew(uint16 index)

   322

{

   323

	return (EngineRenew*)GetItemFromPool(&_engine_renew_pool, index);

   324

}

   325

   326

   327

/**

   328

 * A list to group EngineRenew directives together (such as per-player).

   329

 */

   330

typedef EngineRenew* EngineRenewList;

   331

   332

/**

   333

 * Remove all engine replacement settings for the player.

   334

 * @param  er The renewlist for a given player.

   335

 * @return The new renewlist for the player.

   336

 */

   337

void RemoveAllEngineReplacement(EngineRenewList* erl);

   338

   339

/**

   340

 * Retrieve the engine replacement in a given renewlist for an original engine type.

   341

 * @param  erl The renewlist to search in.

   342

 * @param  engine Engine type to be replaced.

   343

 * @return The engine type to replace with, or INVALID_ENGINE if no

   344

 * replacement is in the list.

   345

 */

   346

EngineID EngineReplacement(EngineRenewList erl, EngineID engine);

   347

   348

/**

   349

 * Add an engine replacement to the given renewlist.

   350

 * @param erl The renewlist to add to.

   351

 * @param old_engine The original engine type.

   352

 * @param new_engine The replacement engine type.

   353

 * @param flags The calling command flags.

   354

 * @return 0 on success, CMD_ERROR on failure.

   355

 */

   356

int32 AddEngineReplacement(EngineRenewList* erl, EngineID old_engine, EngineID new_engine, uint32 flags);

   357

   358

/**

   359

 * Remove an engine replacement from a given renewlist.

   360

 * @param erl The renewlist from which to remove the replacement

   361

 * @param engine The original engine type.

   362

 * @param flags The calling command flags.

   363

 * @return 0 on success, CMD_ERROR on failure.

   364

 */

   365

int32 RemoveEngineReplacement(EngineRenewList* erl, EngineID engine, uint32 flags);

   366

   367

#endif /* ENGINE_H */