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;

    24

	byte ai_rank;

    25

	byte callbackmask; // see CallbackMask enum

    26

	uint16 pow_wag_power;

    27

	byte pow_wag_weight;

    28

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

    29

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

    30

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

    31

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

    32

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

    33

} RailVehicleInfo;

    34

    35

typedef struct ShipVehicleInfo {

    36

	byte image_index;

    37

	byte base_cost;

    38

	uint16 max_speed;

    40

	uint16 capacity;

    41

	byte running_cost;

    42

	byte sfx;

    43

	byte refittable;

    44

	byte callbackmask;

    45

} ShipVehicleInfo;

    46

    47

typedef struct AircraftVehicleInfo {

    48

	byte image_index;

    49

	byte base_cost;

    50

	byte running_cost;

    51

	byte subtype;

    52

	byte sfx;

    53

	byte acceleration;

    54

	byte max_speed;

    55

	byte mail_capacity;

    56

	uint16 passenger_capacity;

    57

	byte callbackmask;

    58

} AircraftVehicleInfo;

    59

    60

typedef struct RoadVehicleInfo {

    61

	byte image_index;

    62

	byte base_cost;

    63

	byte running_cost;

    64

	byte sfx;

    65

	byte max_speed;

    66

	byte capacity;

    68

	byte callbackmask;

    69

} RoadVehicleInfo;

    70

    71

/** Information about a vehicle

    72

  * @see table/engines.h

    73

  */

    74

typedef struct EngineInfo {

    75

	uint16 base_intro;

    76

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

    77

	byte lifelength;

    78

	byte base_life;

    79

	byte railtype:4;

    80

	byte climates:4;

    81

	uint32 refit_mask;

    82

	byte misc_flags;

    83

} EngineInfo;

    84

    85

typedef struct Engine {

    86

	uint16 intro_date;

    87

	uint16 age;

    88

	uint16 reliability;

    89

	uint16 reliability_spd_dec;

    90

	uint16 reliability_start, reliability_max, reliability_final;

    91

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

    92

	byte lifelength;

    93

	byte flags;

    94

	byte preview_player;

    95

	byte preview_wait;

    96

	byte railtype;

    97

	byte player_avail;

    98

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

    99

} Engine;

   100

   101

/**

   102

 * EngineInfo.misc_flags is a bitmask, with the following values

   103

 */

   104

enum {

   105

	EF_RAIL_TILTS = 0, ///< Rail vehicle tilts in curves (unsupported)

   106

	EF_ROAD_TRAM  = 0, ///< Road vehicle is a tram/light rail vehicle (unsup)

   107

	EF_USES_2CC   = 1, ///< Vehicle uses two company colours

   108

	EF_RAIL_IS_MU = 2, ///< Rail vehicle is a multiple-unit (DMU/EMU)

   109

};

   110

   111

enum {

   112

	RVI_MULTIHEAD = 1,

   113

	RVI_WAGON = 2,

   114

};

   115

   116

enum {

   117

	NUM_VEHICLE_TYPES = 6

   118

};

   119

   120

enum {

   121

	INVALID_ENGINE = 0xFFFF,

   122

};

   123

   124

void AddTypeToEngines(void);

   125

void StartupEngines(void);

   126

   127

enum GlobalCargo {

   128

	GC_PASSENGERS   =   0,

   129

	GC_COAL         =   1,

   130

	GC_MAIL         =   2,

   131

	GC_OIL          =   3,

   132

	GC_LIVESTOCK    =   4,

   133

	GC_GOODS        =   5,

   134

	GC_GRAIN        =   6, // GC_WHEAT / GC_MAIZE

   135

	GC_WOOD         =   7,

   136

	GC_IRON_ORE     =   8,

   137

	GC_STEEL        =   9,

   138

	GC_VALUABLES    =  10, // GC_GOLD / GC_DIAMONDS

   139

	GC_PAPER        =  11,

   140

	GC_FOOD         =  12,

   141

	GC_FRUIT        =  13,

   142

	GC_COPPER_ORE   =  14,

   143

	GC_WATER        =  15,

   144

	GC_RUBBER       =  16,

   145

	GC_SUGAR        =  17,

   146

	GC_TOYS         =  18,

   147

	GC_BATTERIES    =  19,

   148

	GC_CANDY        =  20,

   149

	GC_TOFFEE       =  21,

   150

	GC_COLA         =  22,

   151

	GC_COTTON_CANDY =  23,

   152

	GC_BUBBLES      =  24,

   153

	GC_PLASTIC      =  25,

   154

	GC_FIZZY_DRINKS =  26,

   155

	GC_PAPER_TEMP   =  27,

   156

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

   157

	GC_DEFAULT      =  29,

   158

	GC_PURCHASE     =  30,

   159

	GC_INVALID      = 255,

   160

	NUM_GLOBAL_CID  =  31

   161

};

   162

   163

VARDEF const uint32 _default_refitmasks[NUM_VEHICLE_TYPES];

   164

VARDEF const CargoID _global_cargo_id[NUM_LANDSCAPE][NUM_CARGO];

   165

VARDEF const uint32 _landscape_global_cargo_mask[NUM_LANDSCAPE];

   166

VARDEF const CargoID _local_cargo_id_ctype[NUM_GLOBAL_CID];

   167

VARDEF const uint32 cargo_classes[16];

   168

   169

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

   170

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

   171

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

   172

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

   173

   174

void LoadCustomEngineNames(void);

   175

void DeleteCustomEngineNames(void);

   176

   177

bool IsEngineBuildable(uint engine, byte type);

   178

   179

enum {

   180

	NUM_NORMAL_RAIL_ENGINES = 54,

   181

	NUM_MONORAIL_ENGINES = 30,

   182

	NUM_MAGLEV_ENGINES = 32,

   183

	NUM_TRAIN_ENGINES = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   184

	NUM_ROAD_ENGINES = 88,

   185

	NUM_SHIP_ENGINES = 11,

   186

	NUM_AIRCRAFT_ENGINES = 41,

   187

	TOTAL_NUM_ENGINES = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   188

	AIRCRAFT_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   189

	SHIP_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   190

	ROAD_ENGINES_INDEX = NUM_TRAIN_ENGINES,

   191

};

   192

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   193

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

   194

   195

static inline Engine* GetEngine(EngineID i)

   196

{

   197

  assert(i < lengthof(_engines));

   198

  return &_engines[i];

   199

}

   200

   201

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   202

   203

static inline bool IsEngineIndex(uint index)

   204

{

   205

	return index < TOTAL_NUM_ENGINES;

   206

}

   207

   208

/* Access Vehicle Data */

   209

//#include "table/engines.h"

   210

extern const EngineInfo orig_engine_info[TOTAL_NUM_ENGINES];

   211

extern const RailVehicleInfo orig_rail_vehicle_info[NUM_TRAIN_ENGINES];

   212

extern const ShipVehicleInfo orig_ship_vehicle_info[NUM_SHIP_ENGINES];

   213

extern const AircraftVehicleInfo orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   214

extern const RoadVehicleInfo orig_road_vehicle_info[NUM_ROAD_ENGINES];

   215

   216

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   217

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   218

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   219

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   220

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   221

   222

static inline const RailVehicleInfo* RailVehInfo(EngineID e)

   223

{

   224

	assert(e < lengthof(_rail_vehicle_info));

   225

	return &_rail_vehicle_info[e];

   226

}

   227

   228

static inline const ShipVehicleInfo* ShipVehInfo(EngineID e)

   229

{

   230

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

   231

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   232

}

   233

   234

static inline const AircraftVehicleInfo* AircraftVehInfo(EngineID e)

   235

{

   236

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

   237

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   238

}

   239

   240

static inline const RoadVehicleInfo* RoadVehInfo(EngineID e)

   241

{

   242

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

   243

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   244

}

   245

   246

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

   247

 * Engine Replacement stuff

   248

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

   249

   250

/**

   251

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

   252

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

   253

 * it.

   254

 */

   255

struct EngineRenew {

   256

	uint16 index;

   257

	EngineID from;

   258

	EngineID to;

   259

	struct EngineRenew *next;

   260

};

   261

   262

typedef struct EngineRenew EngineRenew;

   263

   264

/**

   265

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

   266

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

   267

 * it.

   268

 */

   269

extern MemoryPool _engine_renew_pool;

   270

   271

/**

   272

 * DO NOT USE outside of engine.c. Is

   273

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

   274

 * it.

   275

 */

   276

static inline EngineRenew *GetEngineRenew(uint16 index)

   277

{

   278

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

   279

}

   280

   281

   282

/**

   283

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

   284

 */

   285

typedef EngineRenew* EngineRenewList;

   286

   287

/**

   288

 * Remove all engine replacement settings for the player.

   289

 * @param  er The renewlist for a given player.

   290

 * @return The new renewlist for the player.

   291

 */

   292

void RemoveAllEngineReplacement(EngineRenewList* erl);

   293

   294

/**

   295

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

   296

 * @param  erl The renewlist to search in.

   297

 * @param  engine Engine type to be replaced.

   298

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

   299

 * replacement is in the list.

   300

 */

   301

EngineID EngineReplacement(EngineRenewList erl, EngineID engine);

   302

   303

/**

   304

 * Add an engine replacement to the given renewlist.

   305

 * @param erl The renewlist to add to.

   306

 * @param old_engine The original engine type.

   307

 * @param new_engine The replacement engine type.

   308

 * @param flags The calling command flags.

   309

 * @return 0 on success, CMD_ERROR on failure.

   310

 */

   311

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

   312

   313

/**

   314

 * Remove an engine replacement from a given renewlist.

   315

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

   316

 * @param engine The original engine type.

   317

 * @param flags The calling command flags.

   318

 * @return 0 on success, CMD_ERROR on failure.

   319

 */

   320

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

   321

   322

#endif /* ENGINE_H */