1

/* $Id$ */

     2

     3

#ifndef ENGINE_H

     4

#define ENGINE_H

     5

     6

/** @file engine.h */

     7

     8

#include "oldpool.h"

     9

    10

typedef struct RailVehicleInfo {

    11

	byte image_index;

    12

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

    13

	byte base_cost;

    14

	uint16 max_speed;

    15

	uint16 power;

    16

	uint16 weight;

    17

	byte running_cost_base;

    18

	byte running_cost_class;

    19

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

    20

	byte capacity;

    21

	CargoID cargo_type;

    22

	byte ai_rank;

    23

	uint16 pow_wag_power;

    24

	byte pow_wag_weight;

    25

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

    26

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

    27

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

    28

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

    29

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

    30

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

    31

} RailVehicleInfo;

    32

    33

typedef struct ShipVehicleInfo {

    34

	byte image_index;

    35

	byte base_cost;

    36

	uint16 max_speed;

    37

	CargoID cargo_type;

    38

	uint16 capacity;

    39

	byte running_cost;

    40

	byte sfx;

    41

	byte refittable;

    42

} ShipVehicleInfo;

    43

    44

// Aircraft subtypes

    45

enum {

    46

	AIR_CTOL = 1, // Conventional Take Off and Landing, i.e. planes

    47

	AIR_FAST = 2

    48

};

    49

    50

typedef struct AircraftVehicleInfo {

    51

	byte image_index;

    52

	byte base_cost;

    53

	byte running_cost;

    54

	byte subtype;

    55

	byte sfx;

    56

	byte acceleration;

    57

	byte max_speed;

    58

	byte mail_capacity;

    59

	uint16 passenger_capacity;

    60

} AircraftVehicleInfo;

    61

    62

typedef struct RoadVehicleInfo {

    63

	byte image_index;

    64

	byte base_cost;

    65

	byte running_cost;

    66

	byte sfx;

    67

	byte max_speed;

    68

	byte capacity;

    69

	CargoID cargo_type;

    70

} RoadVehicleInfo;

    71

    72

/** Information about a vehicle

    73

 *  @see table/engines.h

    74

 */

    75

typedef struct EngineInfo {

    76

	Date base_intro;

    77

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

    78

	Year lifelength;

    79

	Year base_life;

    80

	byte load_amount;

    81

	byte railtype:4;

    82

	byte climates:4;

    83

	uint32 refit_mask;

    84

	byte refit_cost;

    85

	byte misc_flags;

    86

	byte callbackmask;

    87

} EngineInfo;

    88

    89

typedef struct Engine {

    90

	Date intro_date;

    91

	Date age;

    92

	uint16 reliability;

    93

	uint16 reliability_spd_dec;

    94

	uint16 reliability_start, reliability_max, reliability_final;

    95

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

    96

	byte lifelength;

    97

	byte flags;

    98

	byte preview_player;

    99

	byte preview_wait;

   100

	byte railtype;

   101

	byte player_avail;

   102

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

   103

} Engine;

   104

   105

/**

   106

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

   107

 */

   108

enum {

   109

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

   110

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

   111

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

   112

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

   113

};

   114

   115

enum {

   116

	RVI_MULTIHEAD = 1,

   117

	RVI_WAGON = 2,

   118

};

   119

   120

enum {

   121

	NUM_VEHICLE_TYPES = 6

   122

};

   123

   124

enum {

   125

	INVALID_ENGINE = 0xFFFF,

   126

};

   127

   128

void AddTypeToEngines(void);

   129

void StartupEngines(void);

   130

   131

   132

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

   133

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

   134

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

   135

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

   136

   137

void LoadCustomEngineNames(void);

   138

void DeleteCustomEngineNames(void);

   139

   140

bool IsEngineBuildable(EngineID engine, byte type, PlayerID player);

   141

   142

enum {

   143

	NUM_NORMAL_RAIL_ENGINES = 54,

   144

	NUM_MONORAIL_ENGINES    = 30,

   145

	NUM_MAGLEV_ENGINES      = 32,

   146

	NUM_TRAIN_ENGINES       = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   147

	NUM_ROAD_ENGINES        = 88,

   148

	NUM_SHIP_ENGINES        = 11,

   149

	NUM_AIRCRAFT_ENGINES    = 41,

   150

	TOTAL_NUM_ENGINES       = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   151

	AIRCRAFT_ENGINES_INDEX  = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   152

	SHIP_ENGINES_INDEX      = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   153

	ROAD_ENGINES_INDEX      = NUM_TRAIN_ENGINES,

   154

};

   155

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   156

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

   157

   158

static inline Engine* GetEngine(EngineID i)

   159

{

   160

	assert(i < lengthof(_engines));

   161

	return &_engines[i];

   162

}

   163

   164

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   165

   166

static inline bool IsEngineIndex(uint index)

   167

{

   168

	return index < TOTAL_NUM_ENGINES;

   169

}

   170

   171

/* Access Vehicle Data */

   172

//#include "table/engines.h"

   173

extern const EngineInfo orig_engine_info[TOTAL_NUM_ENGINES];

   174

extern const RailVehicleInfo orig_rail_vehicle_info[NUM_TRAIN_ENGINES];

   175

extern const ShipVehicleInfo orig_ship_vehicle_info[NUM_SHIP_ENGINES];

   176

extern const AircraftVehicleInfo orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   177

extern const RoadVehicleInfo orig_road_vehicle_info[NUM_ROAD_ENGINES];

   178

   179

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   180

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   181

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   182

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   183

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   184

   185

static inline const EngineInfo *EngInfo(EngineID e)

   186

{

   187

	assert(e < lengthof(_engine_info));

   188

	return &_engine_info[e];

   189

}

   190

   191

static inline const RailVehicleInfo* RailVehInfo(EngineID e)

   192

{

   193

	assert(e < lengthof(_rail_vehicle_info));

   194

	return &_rail_vehicle_info[e];

   195

}

   196

   197

static inline const ShipVehicleInfo* ShipVehInfo(EngineID e)

   198

{

   199

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

   200

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   201

}

   202

   203

static inline const AircraftVehicleInfo* AircraftVehInfo(EngineID e)

   204

{

   205

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

   206

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   207

}

   208

   209

static inline const RoadVehicleInfo* RoadVehInfo(EngineID e)

   210

{

   211

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

   212

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   213

}

   214

   215

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

   216

 * Engine Replacement stuff

   217

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

   218

   219

/**

   220

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

   221

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

   222

 * it.

   223

 */

   224

struct EngineRenew {

   225

	EngineRenewID index;

   226

	EngineID from;

   227

	EngineID to;

   228

	struct EngineRenew *next;

   229

};

   230

   231

typedef struct EngineRenew EngineRenew;

   232

   233

/**

   234

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

   235

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

   236

 * it.

   237

 */

   238

DECLARE_OLD_POOL(EngineRenew, EngineRenew, 3, 8000)

   239

   240

/**

   241

 * Check if a EngineRenew really exists.

   242

 */

   243

static inline bool IsValidEngineRenew(const EngineRenew *er)

   244

{

   245

	return er->from != INVALID_ENGINE;

   246

}

   247

   248

static inline void DeleteEngineRenew(EngineRenew *er)

   249

{

   250

	er->from = INVALID_ENGINE;

   251

}

   252

   253

#define FOR_ALL_ENGINE_RENEWS_FROM(er, start) for (er = GetEngineRenew(start); er != NULL; er = (er->index + 1U < GetEngineRenewPoolSize()) ? GetEngineRenew(er->index + 1U) : NULL) if (er->from != INVALID_ENGINE) if (IsValidEngineRenew(er))

   254

#define FOR_ALL_ENGINE_RENEWS(er) FOR_ALL_ENGINE_RENEWS_FROM(er, 0)

   255

   256

   257

/**

   258

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

   259

 */

   260

typedef EngineRenew* EngineRenewList;

   261

   262

/**

   263

 * Remove all engine replacement settings for the player.

   264

 * @param  er The renewlist for a given player.

   265

 * @return The new renewlist for the player.

   266

 */

   267

void RemoveAllEngineReplacement(EngineRenewList* erl);

   268

   269

/**

   270

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

   271

 * @param  erl The renewlist to search in.

   272

 * @param  engine Engine type to be replaced.

   273

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

   274

 * replacement is in the list.

   275

 */

   276

EngineID EngineReplacement(EngineRenewList erl, EngineID engine);

   277

   278

/**

   279

 * Add an engine replacement to the given renewlist.

   280

 * @param erl The renewlist to add to.

   281

 * @param old_engine The original engine type.

   282

 * @param new_engine The replacement engine type.

   283

 * @param flags The calling command flags.

   284

 * @return 0 on success, CMD_ERROR on failure.

   285

 */

   286

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

   287

   288

/**

   289

 * Remove an engine replacement from a given renewlist.

   290

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

   291

 * @param engine The original engine type.

   292

 * @param flags The calling command flags.

   293

 * @return 0 on success, CMD_ERROR on failure.

   294

 */

   295

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

   296

   297

/* Engine list manipulators - current implementation is only C wrapper of CBlobT<EngineID> class (helpers.cpp) */

   298

void EngList_Create(EngineList *el);            ///< Creates engine list

   299

void EngList_Destroy(EngineList *el);           ///< Deallocate and destroy engine list

   300

uint EngList_Count(const EngineList *el);       ///< Returns number of items in the engine list

   301

void EngList_Add(EngineList *el, EngineID eid); ///< Append one item at the end of engine list

   302

EngineID* EngList_Items(EngineList *el);        ///< Returns engine list items as C array

   303

void EngList_RemoveAll(EngineList *el);         ///< Removes all items from engine list

   304

typedef int CDECL EngList_SortTypeFunction(const void*, const void*); ///< argument type for EngList_Sort()

   305

void EngList_Sort(EngineList *el, EngList_SortTypeFunction compare); ///< qsort of the engine list

   306

void EngList_SortPartial(EngineList *el, EngList_SortTypeFunction compare, uint begin, uint num_items); ///< qsort of specified portion of the engine list

   307

   308

#endif /* ENGINE_H */