1

/* $Id$ */

     2

     3

#ifndef ENGINE_H

     4

#define ENGINE_H

     5

     6

/** @file engine.h */

     7

     8

#include "oldpool.h"

     9

#include "rail.h"

    10

#include "sound.h"

    11

    12

enum RailVehicleTypes {

    13

	RAILVEH_SINGLEHEAD,

    14

	RAILVEH_MULTIHEAD,

    15

	RAILVEH_WAGON,

    16

};

    17

    18

typedef struct RailVehicleInfo {

    19

	byte image_index;

    20

	RailVehicleTypes railveh_type;

    21

	byte base_cost;

    22

	RailTypeByte railtype;

    23

	uint16 max_speed;

    24

	uint16 power;

    25

	uint16 weight;

    26

	byte running_cost_base;

    27

	byte running_cost_class;

    28

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

    29

	byte capacity;

    30

	CargoID cargo_type;

    31

	byte ai_rank;

    32

	uint16 pow_wag_power;

    33

	byte pow_wag_weight;

    34

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

    35

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

    36

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

    37

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

    38

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

    39

	byte tractive_effort; ///< Tractive effort coefficient

    40

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

    41

} RailVehicleInfo;

    42

    43

typedef struct ShipVehicleInfo {

    44

	byte image_index;

    45

	byte base_cost;

    46

	uint16 max_speed;

    47

	CargoID cargo_type;

    48

	uint16 capacity;

    49

	byte running_cost;

    50

	SoundFxByte sfx;

    51

	bool refittable;

    52

} ShipVehicleInfo;

    53

    54

/* AircraftVehicleInfo subtypes, bitmask type.

    55

 * If bit 0 is 0 then it is a helicopter, otherwise it is a plane

    56

 * in which case bit 1 tells us whether it's a big(fast) plane or not */

    57

enum {

    58

	AIR_HELI = 0,

    59

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

    60

	AIR_FAST = 2

    61

};

    62

    63

typedef struct AircraftVehicleInfo {

    64

	byte image_index;

    65

	byte base_cost;

    66

	byte running_cost;

    67

	byte subtype;

    68

	SoundFxByte sfx;

    69

	byte acceleration;

    70

	byte max_speed;

    71

	byte mail_capacity;

    72

	uint16 passenger_capacity;

    73

} AircraftVehicleInfo;

    74

    75

typedef struct RoadVehicleInfo {

    76

	byte image_index;

    77

	byte base_cost;

    78

	byte running_cost;

    79

	SoundFxByte sfx;

    80

	byte max_speed;

    81

	byte capacity;

    82

	CargoID cargo_type;

    83

} RoadVehicleInfo;

    84

    85

/** Information about a vehicle

    86

 *  @see table/engines.h

    87

 */

    88

typedef struct EngineInfo {

    89

	Date base_intro;

    90

	Year lifelength;

    91

	Year base_life;

    92

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

    93

	byte load_amount;

    94

	byte climates;

    95

	uint32 refit_mask;

    96

	byte refit_cost;

    97

	byte misc_flags;

    98

	byte callbackmask;

    99

} EngineInfo;

   100

   101

typedef struct Engine {

   102

	Date intro_date;

   103

	Date age;

   104

	uint16 reliability;

   105

	uint16 reliability_spd_dec;

   106

	uint16 reliability_start, reliability_max, reliability_final;

   107

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

   108

	byte lifelength;

   109

	byte flags;

   110

	PlayerByte preview_player;

   111

	byte preview_wait;

   112

	byte player_avail;

   113

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

   114

} Engine;

   115

   116

/**

   117

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

   118

 */

   119

enum {

   120

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

   121

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

   122

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

   123

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

   124

};

   125

   126

enum {

   127

	NUM_VEHICLE_TYPES = 6

   128

};

   129

   130

static const EngineID INVALID_ENGINE = 0xFFFF;

   131

   132

   133

void AddTypeToEngines(void);

   134

void StartupEngines(void);

   135

   136

   137

void DrawTrainEngine(int x, int y, EngineID engine, SpriteID pal);

   138

void DrawRoadVehEngine(int x, int y, EngineID engine, SpriteID pal);

   139

void DrawShipEngine(int x, int y, EngineID engine, SpriteID pal);

   140

void DrawAircraftEngine(int x, int y, EngineID engine, SpriteID pal);

   141

   142

void LoadCustomEngineNames(void);

   143

void DeleteCustomEngineNames(void);

   144

   145

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

   146

   147

enum {

   148

	NUM_NORMAL_RAIL_ENGINES = 54,

   149

	NUM_MONORAIL_ENGINES    = 30,

   150

	NUM_MAGLEV_ENGINES      = 32,

   151

	NUM_TRAIN_ENGINES       = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   152

	NUM_ROAD_ENGINES        = 88,

   153

	NUM_SHIP_ENGINES        = 11,

   154

	NUM_AIRCRAFT_ENGINES    = 41,

   155

	TOTAL_NUM_ENGINES       = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   156

	AIRCRAFT_ENGINES_INDEX  = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   157

	SHIP_ENGINES_INDEX      = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   158

	ROAD_ENGINES_INDEX      = NUM_TRAIN_ENGINES,

   159

};

   160

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   161

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

   162

   163

static inline Engine* GetEngine(EngineID i)

   164

{

   165

	assert(i < lengthof(_engines));

   166

	return &_engines[i];

   167

}

   168

   169

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   170

   171

static inline bool IsEngineIndex(uint index)

   172

{

   173

	return index < TOTAL_NUM_ENGINES;

   174

}

   175

   176

/* Access Vehicle Data */

   177

//#include "table/engines.h"

   178

extern const EngineInfo orig_engine_info[TOTAL_NUM_ENGINES];

   179

extern const RailVehicleInfo orig_rail_vehicle_info[NUM_TRAIN_ENGINES];

   180

extern const ShipVehicleInfo orig_ship_vehicle_info[NUM_SHIP_ENGINES];

   181

extern const AircraftVehicleInfo orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   182

extern const RoadVehicleInfo orig_road_vehicle_info[NUM_ROAD_ENGINES];

   183

   184

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   185

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   186

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   187

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   188

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   189

   190

static inline const EngineInfo *EngInfo(EngineID e)

   191

{

   192

	assert(e < lengthof(_engine_info));

   193

	return &_engine_info[e];

   194

}

   195

   196

static inline const RailVehicleInfo* RailVehInfo(EngineID e)

   197

{

   198

	assert(e < lengthof(_rail_vehicle_info));

   199

	return &_rail_vehicle_info[e];

   200

}

   201

   202

static inline const ShipVehicleInfo* ShipVehInfo(EngineID e)

   203

{

   204

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

   205

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   206

}

   207

   208

static inline const AircraftVehicleInfo* AircraftVehInfo(EngineID e)

   209

{

   210

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

   211

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   212

}

   213

   214

static inline const RoadVehicleInfo* RoadVehInfo(EngineID e)

   215

{

   216

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

   217

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   218

}

   219

   220

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

   221

 * Engine Replacement stuff

   222

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

   223

   224

/**

   225

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

   226

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

   227

 * it.

   228

 */

   229

struct EngineRenew {

   230

	EngineRenewID index;

   231

	EngineID from;

   232

	EngineID to;

   233

	struct EngineRenew *next;

   234

};

   235

   236

typedef struct EngineRenew EngineRenew;

   237

   238

/**

   239

 * Memory pool for engine renew elements. 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

DECLARE_OLD_POOL(EngineRenew, EngineRenew, 3, 8000)

   244

   245

/**

   246

 * Check if a EngineRenew really exists.

   247

 */

   248

static inline bool IsValidEngineRenew(const EngineRenew *er)

   249

{

   250

	return er->from != INVALID_ENGINE;

   251

}

   252

   253

static inline void DeleteEngineRenew(EngineRenew *er)

   254

{

   255

	er->from = INVALID_ENGINE;

   256

}

   257

   258

#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))

   259

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

   260

   261

   262

/**

   263

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

   264

 */

   265

typedef EngineRenew* EngineRenewList;

   266

   267

/**

   268

 * Remove all engine replacement settings for the player.

   269

 * @param  er The renewlist for a given player.

   270

 * @return The new renewlist for the player.

   271

 */

   272

void RemoveAllEngineReplacement(EngineRenewList* erl);

   273

   274

/**

   275

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

   276

 * @param  erl The renewlist to search in.

   277

 * @param  engine Engine type to be replaced.

   278

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

   279

 * replacement is in the list.

   280

 */

   281

EngineID EngineReplacement(EngineRenewList erl, EngineID engine);

   282

   283

/**

   284

 * Add an engine replacement to the given renewlist.

   285

 * @param erl The renewlist to add to.

   286

 * @param old_engine The original engine type.

   287

 * @param new_engine The replacement engine type.

   288

 * @param flags The calling command flags.

   289

 * @return 0 on success, CMD_ERROR on failure.

   290

 */

   291

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

   292

   293

/**

   294

 * Remove an engine replacement from a given renewlist.

   295

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

   296

 * @param engine The original engine type.

   297

 * @param flags The calling command flags.

   298

 * @return 0 on success, CMD_ERROR on failure.

   299

 */

   300

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

   301

   302

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

   303

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

   304

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

   305

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

   306

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

   307

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

   308

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

   309

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

   310

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

   311

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

   312

   313

#endif /* ENGINE_H */