1

/* $Id$ */

     2

     3

/** @file engine.h */

     4

     5

#ifndef ENGINE_H

     6

#define ENGINE_H

     7

     8

#include "rail_type.h"

     9

#include "cargo_type.h"

    10

#include "vehicle_type.h"

    11

#include "gfx_type.h"

    12

#include "date_type.h"

    13

#include "sound_type.h"

    14

    15

enum RailVehicleTypes {

    16

	RAILVEH_SINGLEHEAD,  ///< indicates a "standalone" locomotive

    17

	RAILVEH_MULTIHEAD,   ///< indicates a combination of two locomotives

    18

	RAILVEH_WAGON,       ///< simple wagon, not motorized

    19

};

    20

    21

enum EngineClass {

    22

	EC_STEAM,

    23

	EC_DIESEL,

    24

	EC_ELECTRIC,

    25

	EC_MONORAIL,

    26

	EC_MAGLEV,

    27

};

    28

    29

struct RailVehicleInfo {

    30

	byte image_index;

    31

	RailVehicleTypes railveh_type;

    32

	byte base_cost;

    33

	RailTypeByte railtype;

    34

	uint16 max_speed;

    35

	uint16 power;

    36

	uint16 weight;

    37

	byte running_cost_base;

    38

	byte running_cost_class;

    39

	EngineClass engclass;           ///< Class of engine for this vehicle

    40

	byte capacity;

    41

	CargoID cargo_type;

    42

	byte ai_rank;

    43

	uint16 pow_wag_power;

    44

	byte pow_wag_weight;

    45

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

    46

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

    47

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

    48

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

    49

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

    50

	byte tractive_effort;  ///< Tractive effort coefficient

    51

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

    52

};

    53

    54

struct ShipVehicleInfo {

    55

	byte image_index;

    56

	byte base_cost;

    57

	uint16 max_speed;

    58

	CargoID cargo_type;

    59

	uint16 capacity;

    60

	byte running_cost;

    61

	SoundFxByte sfx;

    62

	bool refittable;

    63

};

    64

    65

/* AircraftVehicleInfo subtypes, bitmask type.

    66

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

    67

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

    68

enum {

    69

	AIR_HELI = 0,

    70

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

    71

	AIR_FAST = 2

    72

};

    73

    74

struct AircraftVehicleInfo {

    75

	byte image_index;

    76

	byte base_cost;

    77

	byte running_cost;

    78

	byte subtype;

    79

	SoundFxByte sfx;

    80

	byte acceleration;

    81

	uint16 max_speed;

    82

	byte mail_capacity;

    83

	uint16 passenger_capacity;

    84

};

    85

    86

struct RoadVehicleInfo {

    87

	byte image_index;

    88

	byte base_cost;

    89

	byte running_cost;

    90

	SoundFxByte sfx;

    91

	byte max_speed;

    92

	byte capacity;

    93

	CargoID cargo_type;

    94

};

    95

    96

/** Information about a vehicle

    97

 *  @see table/engines.h

    98

 */

    99

struct EngineInfo {

   100

	Date base_intro;

   101

	Year lifelength;

   102

	Year base_life;

   103

	byte unk2;         ///< flag for carriage(bit 7) and decay speed(bits0..6)

   104

	byte load_amount;

   105

	byte climates;

   106

	uint32 refit_mask;

   107

	byte refit_cost;

   108

	byte misc_flags;

   109

	byte callbackmask;

   110

	byte retire_early; ///< Number of years early to retire vehicle

   111

};

   112

   113

struct Engine {

   114

	Date intro_date;

   115

	Date age;

   116

	uint16 reliability;

   117

	uint16 reliability_spd_dec;

   118

	uint16 reliability_start, reliability_max, reliability_final;

   119

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

   120

	byte lifelength;

   121

	byte flags;

   122

	PlayerByte preview_player;

   123

	byte preview_wait;

   124

	byte player_avail;

   125

	VehicleType type; ///< type, ie VEH_ROAD, VEH_TRAIN, etc.

   126

};

   127

   128

/**

   129

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

   130

 */

   131

enum {

   132

	EF_RAIL_TILTS = 0, ///< Rail vehicle tilts in curves

   133

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

   134

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

   135

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

   136

};

   137

   138

/**

   139

 * Engine.flags is a bitmask, with the following values.

   140

 */

   141

enum {

   142

	ENGINE_AVAILABLE         = 1, ///< This vehicle is available to everyone.

   143

	ENGINE_EXCLUSIVE_PREVIEW = 2, ///< This vehicle is in the exclusive preview stage, either being used or being offered to a player.

   144

	ENGINE_OFFER_WINDOW_OPEN = 4, ///< The exclusive offer window is currently open for a player.

   145

};

   146

   147

enum {

   148

	NUM_VEHICLE_TYPES = 6

   149

};

   150

   151

static const EngineID INVALID_ENGINE = 0xFFFF;

   152

   153

   154

void SetupEngines();

   155

void StartupEngines();

   156

   157

   158

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

   159

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

   160

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

   161

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

   162

   163

void LoadCustomEngineNames();

   164

void DeleteCustomEngineNames();

   165

   166

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

   167

CargoID GetEngineCargoType(EngineID engine);

   168

   169

enum {

   170

	NUM_NORMAL_RAIL_ENGINES = 54,

   171

	NUM_MONORAIL_ENGINES    = 30,

   172

	NUM_MAGLEV_ENGINES      = 32,

   173

	NUM_TRAIN_ENGINES       = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   174

	NUM_ROAD_ENGINES        = 88,

   175

	NUM_SHIP_ENGINES        = 11,

   176

	NUM_AIRCRAFT_ENGINES    = 41,

   177

	TOTAL_NUM_ENGINES       = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   178

	AIRCRAFT_ENGINES_INDEX  = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   179

	SHIP_ENGINES_INDEX      = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   180

	ROAD_ENGINES_INDEX      = NUM_TRAIN_ENGINES,

   181

};

   182

   183

static inline EngineID GetFirstEngineOfType(byte type)

   184

{

   185

	const EngineID start[] = {0, ROAD_ENGINES_INDEX, SHIP_ENGINES_INDEX, AIRCRAFT_ENGINES_INDEX};

   186

   187

	return start[type];

   188

}

   189

   190

static inline EngineID GetLastEngineOfType(byte type)

   191

{

   192

	const EngineID end[] = {

   193

		NUM_TRAIN_ENGINES,

   194

		ROAD_ENGINES_INDEX + NUM_ROAD_ENGINES,

   195

		SHIP_ENGINES_INDEX + NUM_SHIP_ENGINES,

   196

		AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES};

   197

   198

	return end[type];

   199

}

   200

   201

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   202

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

   203

#define FOR_ALL_ENGINEIDS_OF_TYPE(e, type) for (e = GetFirstEngineOfType(type); e != GetLastEngineOfType(type); e++)

   204

   205

   206

static inline Engine* GetEngine(EngineID i)

   207

{

   208

	assert(i < lengthof(_engines));

   209

	return &_engines[i];

   210

}

   211

   212

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   213

   214

static inline bool IsEngineIndex(uint index)

   215

{

   216

	return index < TOTAL_NUM_ENGINES;

   217

}

   218

   219

/* Access Vehicle Data */

   220

extern const EngineInfo _orig_engine_info[TOTAL_NUM_ENGINES];

   221

extern const RailVehicleInfo _orig_rail_vehicle_info[NUM_TRAIN_ENGINES];

   222

extern const ShipVehicleInfo _orig_ship_vehicle_info[NUM_SHIP_ENGINES];

   223

extern const AircraftVehicleInfo _orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   224

extern const RoadVehicleInfo _orig_road_vehicle_info[NUM_ROAD_ENGINES];

   225

   226

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   227

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   228

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   229

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   230

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   231

   232

static inline const EngineInfo *EngInfo(EngineID e)

   233

{

   234

	assert(e < lengthof(_engine_info));

   235

	return &_engine_info[e];

   236

}

   237

   238

static inline const RailVehicleInfo* RailVehInfo(EngineID e)

   239

{

   240

	assert(e < lengthof(_rail_vehicle_info));

   241

	return &_rail_vehicle_info[e];

   242

}

   243

   244

static inline const ShipVehicleInfo* ShipVehInfo(EngineID e)

   245

{

   246

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

   247

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   248

}

   249

   250

static inline const AircraftVehicleInfo* AircraftVehInfo(EngineID e)

   251

{

   252

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

   253

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   254

}

   255

   256

static inline const RoadVehicleInfo* RoadVehInfo(EngineID e)

   257

{

   258

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

   259

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   260

}

   261

   262

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

   263

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

   264

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

   265

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

   266

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

   267

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

   268

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

   269

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

   270

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

   271

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

   272

   273

#endif /* ENGINE_H */