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

	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

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

    33

} RailVehicleInfo;

    34

    35

typedef struct ShipVehicleInfo {

    36

	byte image_index;

    37

	byte base_cost;

    38

	uint16 max_speed;

    39

	CargoID cargo_type;

    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;

    67

	CargoID cargo_type;

    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

   128

VARDEF const uint32 _default_refitmasks[NUM_VEHICLE_TYPES];

   129

   130

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

   131

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

   132

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

   133

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

   134

   135

void LoadCustomEngineNames(void);

   136

void DeleteCustomEngineNames(void);

   137

   138

bool IsEngineBuildable(uint engine, byte type);

   139

   140

enum {

   141

	NUM_NORMAL_RAIL_ENGINES = 54,

   142

	NUM_MONORAIL_ENGINES = 30,

   143

	NUM_MAGLEV_ENGINES = 32,

   144

	NUM_TRAIN_ENGINES = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   145

	NUM_ROAD_ENGINES = 88,

   146

	NUM_SHIP_ENGINES = 11,

   147

	NUM_AIRCRAFT_ENGINES = 41,

   148

	TOTAL_NUM_ENGINES = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   149

	AIRCRAFT_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   150

	SHIP_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   151

	ROAD_ENGINES_INDEX = NUM_TRAIN_ENGINES,

   152

};

   153

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   154

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

   155

   156

static inline Engine* GetEngine(EngineID i)

   157

{

   158

  assert(i < lengthof(_engines));

   159

  return &_engines[i];

   160

}

   161

   162

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   163

   164

static inline bool IsEngineIndex(uint index)

   165

{

   166

	return index < TOTAL_NUM_ENGINES;

   167

}

   168

   169

/* Access Vehicle Data */

   170

//#include "table/engines.h"

   171

extern const EngineInfo orig_engine_info[TOTAL_NUM_ENGINES];

   172

extern const RailVehicleInfo orig_rail_vehicle_info[NUM_TRAIN_ENGINES];

   173

extern const ShipVehicleInfo orig_ship_vehicle_info[NUM_SHIP_ENGINES];

   174

extern const AircraftVehicleInfo orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   175

extern const RoadVehicleInfo orig_road_vehicle_info[NUM_ROAD_ENGINES];

   176

   177

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   178

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   179

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   180

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   181

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   182

   183

static inline const EngineInfo *EngInfo(EngineID e)

   184

{

   185

	assert(e < lengthof(_engine_info));

   186

	return &_engine_info[e];

   187

}

   188

   189

static inline const RailVehicleInfo* RailVehInfo(EngineID e)

   190

{

   191

	assert(e < lengthof(_rail_vehicle_info));

   192

	return &_rail_vehicle_info[e];

   193

}

   194

   195

static inline const ShipVehicleInfo* ShipVehInfo(EngineID e)

   196

{

   197

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

   198

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   199

}

   200

   201

static inline const AircraftVehicleInfo* AircraftVehInfo(EngineID e)

   202

{

   203

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

   204

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   205

}

   206

   207

static inline const RoadVehicleInfo* RoadVehInfo(EngineID e)

   208

{

   209

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

   210

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   211

}

   212

   213

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

   214

 * Engine Replacement stuff

   215

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

   216

   217

/**

   218

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

   219

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

   220

 * it.

   221

 */

   222

struct EngineRenew {

   223

	uint16 index;

   224

	EngineID from;

   225

	EngineID to;

   226

	struct EngineRenew *next;

   227

};

   228

   229

typedef struct EngineRenew EngineRenew;

   230

   231

/**

   232

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

   233

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

   234

 * it.

   235

 */

   236

extern MemoryPool _engine_renew_pool;

   237

   238

/**

   239

 * DO NOT USE outside of engine.c. Is

   240

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

   241

 * it.

   242

 */

   243

static inline EngineRenew *GetEngineRenew(uint16 index)

   244

{

   245

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

   246

}

   247

   248

   249

/**

   250

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

   251

 */

   252

typedef EngineRenew* EngineRenewList;

   253

   254

/**

   255

 * Remove all engine replacement settings for the player.

   256

 * @param  er The renewlist for a given player.

   257

 * @return The new renewlist for the player.

   258

 */

   259

void RemoveAllEngineReplacement(EngineRenewList* erl);

   260

   261

/**

   262

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

   263

 * @param  erl The renewlist to search in.

   264

 * @param  engine Engine type to be replaced.

   265

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

   266

 * replacement is in the list.

   267

 */

   268

EngineID EngineReplacement(EngineRenewList erl, EngineID engine);

   269

   270

/**

   271

 * Add an engine replacement to the given renewlist.

   272

 * @param erl The renewlist to add to.

   273

 * @param old_engine The original engine type.

   274

 * @param new_engine The replacement engine type.

   275

 * @param flags The calling command flags.

   276

 * @return 0 on success, CMD_ERROR on failure.

   277

 */

   278

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

   279

   280

/**

   281

 * Remove an engine replacement from a given renewlist.

   282

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

   283

 * @param engine The original engine type.

   284

 * @param flags The calling command flags.

   285

 * @return 0 on success, CMD_ERROR on failure.

   286

 */

   287

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

   288

   289

#endif /* ENGINE_H */