1

/* $Id$ */

     2

     3

#ifndef ENGINE_H

     4

#define ENGINE_H

     5

     6

/** @file engine.h

     7

  */

     8

     9

#include "pool.h"

    10

    11

typedef struct RailVehicleInfo {

    12

	byte image_index;

    13

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

    14

	byte base_cost;

    15

	uint16 max_speed;

    16

	uint16 power;

    17

	uint16 weight;

    18

	byte running_cost_base;

    19

	byte running_cost_class;

    20

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

    21

	byte capacity;

    22

	CargoID cargo_type;

    23

	byte ai_rank;

    24

	uint16 pow_wag_power;

    25

	byte pow_wag_weight;

    26

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

    27

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

    28

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

    29

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

    30

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

    31

	byte user_def_data; ///! Property 0x25: "User-defined bit mask" Used only for (very few) NewGRF vehicles

    32

} RailVehicleInfo;

    33

    34

typedef struct ShipVehicleInfo {

    35

	byte image_index;

    36

	byte base_cost;

    37

	uint16 max_speed;

    38

	CargoID 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

	CargoID 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

	byte misc_flags;

    79

	byte callbackmask;

    80

} EngineInfo;

    81

    82

typedef struct Engine {

    83

	uint16 intro_date;

    84

	uint16 age;

    85

	uint16 reliability;

    86

	uint16 reliability_spd_dec;

    87

	uint16 reliability_start, reliability_max, reliability_final;

    88

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

    89

	byte lifelength;

    90

	byte flags;

    91

	byte preview_player;

    92

	byte preview_wait;

    93

	byte railtype;

    94

	byte player_avail;

    95

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

    96

} Engine;

    97

    98

/**

    99

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

   100

 */

   101

enum {

   102

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

   103

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

   104

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

   105

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

   106

};

   107

   108

enum {

   109

	RVI_MULTIHEAD = 1,

   110

	RVI_WAGON = 2,

   111

};

   112

   113

enum {

   114

	NUM_VEHICLE_TYPES = 6

   115

};

   116

   117

enum {

   118

	INVALID_ENGINE = 0xFFFF,

   119

};

   120

   121

void AddTypeToEngines(void);

   122

void StartupEngines(void);

   123

   124

   125

VARDEF const uint32 _default_refitmasks[NUM_VEHICLE_TYPES];

   126

   127

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

   128

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

   129

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

   130

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

   131

   132

void LoadCustomEngineNames(void);

   133

void DeleteCustomEngineNames(void);

   134

   135

bool IsEngineBuildable(uint engine, byte type);

   136

   137

enum {

   138

	NUM_NORMAL_RAIL_ENGINES = 54,

   139

	NUM_MONORAIL_ENGINES = 30,

   140

	NUM_MAGLEV_ENGINES = 32,

   141

	NUM_TRAIN_ENGINES = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   142

	NUM_ROAD_ENGINES = 88,

   143

	NUM_SHIP_ENGINES = 11,

   144

	NUM_AIRCRAFT_ENGINES = 41,

   145

	TOTAL_NUM_ENGINES = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   146

	AIRCRAFT_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   147

	SHIP_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   148

	ROAD_ENGINES_INDEX = NUM_TRAIN_ENGINES,

   149

};

   150

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   151

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

   152

   153

static inline Engine* GetEngine(EngineID i)

   154

{

   155

  assert(i < lengthof(_engines));

   156

  return &_engines[i];

   157

}

   158

   159

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   160

   161

static inline bool IsEngineIndex(uint index)

   162

{

   163

	return index < TOTAL_NUM_ENGINES;

   164

}

   165

   166

/* Access Vehicle Data */

   167

//#include "table/engines.h"

   168

extern const EngineInfo orig_engine_info[TOTAL_NUM_ENGINES];

   169

extern const RailVehicleInfo orig_rail_vehicle_info[NUM_TRAIN_ENGINES];

   170

extern const ShipVehicleInfo orig_ship_vehicle_info[NUM_SHIP_ENGINES];

   171

extern const AircraftVehicleInfo orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   172

extern const RoadVehicleInfo orig_road_vehicle_info[NUM_ROAD_ENGINES];

   173

   174

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   175

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   176

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   177

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   178

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   179

   180

static inline const EngineInfo *EngInfo(EngineID e)

   181

{

   182

	assert(e < lengthof(_engine_info));

   183

	return &_engine_info[e];

   184

}

   185

   186

static inline const RailVehicleInfo* RailVehInfo(EngineID e)

   187

{

   188

	assert(e < lengthof(_rail_vehicle_info));

   189

	return &_rail_vehicle_info[e];

   190

}

   191

   192

static inline const ShipVehicleInfo* ShipVehInfo(EngineID e)

   193

{

   194

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

   195

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   196

}

   197

   198

static inline const AircraftVehicleInfo* AircraftVehInfo(EngineID e)

   199

{

   200

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

   201

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   202

}

   203

   204

static inline const RoadVehicleInfo* RoadVehInfo(EngineID e)

   205

{

   206

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

   207

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   208

}

   209

   210

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

   211

 * Engine Replacement stuff

   212

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

   213

   214

/**

   215

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

   216

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

   217

 * it.

   218

 */

   219

struct EngineRenew {

   220

	uint16 index;

   221

	EngineID from;

   222

	EngineID to;

   223

	struct EngineRenew *next;

   224

};

   225

   226

typedef struct EngineRenew EngineRenew;

   227

   228

/**

   229

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

   230

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

   231

 * it.

   232

 */

   233

extern MemoryPool _engine_renew_pool;

   234

   235

/**

   236

 * DO NOT USE outside of engine.c. Is

   237

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

   238

 * it.

   239

 */

   240

static inline EngineRenew *GetEngineRenew(uint16 index)

   241

{

   242

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

   243

}

   244

   245

   246

/**

   247

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

   248

 */

   249

typedef EngineRenew* EngineRenewList;

   250

   251

/**

   252

 * Remove all engine replacement settings for the player.

   253

 * @param  er The renewlist for a given player.

   254

 * @return The new renewlist for the player.

   255

 */

   256

void RemoveAllEngineReplacement(EngineRenewList* erl);

   257

   258

/**

   259

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

   260

 * @param  erl The renewlist to search in.

   261

 * @param  engine Engine type to be replaced.

   262

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

   263

 * replacement is in the list.

   264

 */

   265

EngineID EngineReplacement(EngineRenewList erl, EngineID engine);

   266

   267

/**

   268

 * Add an engine replacement to the given renewlist.

   269

 * @param erl The renewlist to add to.

   270

 * @param old_engine The original engine type.

   271

 * @param new_engine The replacement engine type.

   272

 * @param flags The calling command flags.

   273

 * @return 0 on success, CMD_ERROR on failure.

   274

 */

   275

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

   276

   277

/**

   278

 * Remove an engine replacement from a given renewlist.

   279

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

   280

 * @param engine The original engine type.

   281

 * @param flags The calling command flags.

   282

 * @return 0 on success, CMD_ERROR on failure.

   283

 */

   284

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

   285

   286

#endif /* ENGINE_H */