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

#include "player_type.h"

    15

#include "strings_type.h"

    16

    17

enum RailVehicleTypes {

    18

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

    19

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

    20

	RAILVEH_WAGON,       ///< simple wagon, not motorized

    21

};

    22

    23

enum EngineClass {

    24

	EC_STEAM,

    25

	EC_DIESEL,

    26

	EC_ELECTRIC,

    27

	EC_MONORAIL,

    28

	EC_MAGLEV,

    29

};

    30

    31

struct RailVehicleInfo {

    32

	byte image_index;

    33

	RailVehicleTypes railveh_type;

    34

	byte base_cost;

    35

	RailTypeByte railtype;

    36

	uint16 max_speed;

    37

	uint16 power;

    38

	uint16 weight;

    39

	byte running_cost_base;

    40

	byte running_cost_class;

    41

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

    42

	byte capacity;

    43

	CargoID cargo_type;

    44

	byte ai_rank;

    45

	uint16 pow_wag_power;

    46

	byte pow_wag_weight;

    47

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

    48

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

    49

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

    50

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

    51

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

    52

	byte tractive_effort;  ///< Tractive effort coefficient

    53

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

    54

};

    55

    56

struct ShipVehicleInfo {

    57

	byte image_index;

    58

	byte base_cost;

    59

	uint16 max_speed;

    60

	CargoID cargo_type;

    61

	uint16 capacity;

    62

	byte running_cost;

    63

	SoundFxByte sfx;

    64

	bool refittable;

    65

};

    66

    67

/* AircraftVehicleInfo subtypes, bitmask type.

    68

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

    69

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

    70

enum {

    71

	AIR_HELI = 0,

    72

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

    73

	AIR_FAST = 2

    74

};

    75

    76

struct AircraftVehicleInfo {

    77

	byte image_index;

    78

	byte base_cost;

    79

	byte running_cost;

    80

	byte subtype;

    81

	SoundFxByte sfx;

    82

	byte acceleration;

    83

	uint16 max_speed;

    84

	byte mail_capacity;

    85

	uint16 passenger_capacity;

    86

};

    87

    88

struct RoadVehicleInfo {

    89

	byte image_index;

    90

	byte base_cost;

    91

	byte running_cost;

    92

	SoundFxByte sfx;

    93

	byte max_speed;

    94

	byte capacity;

    95

	CargoID cargo_type;

    96

};

    97

    98

/** Information about a vehicle

    99

 *  @see table/engines.h

   100

 */

   101

struct EngineInfo {

   102

	Date base_intro;

   103

	Year lifelength;

   104

	Year base_life;

   105

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

   106

	byte load_amount;

   107

	byte climates;

   108

	uint32 refit_mask;

   109

	byte refit_cost;

   110

	byte misc_flags;

   111

	byte callbackmask;

   112

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

   113

	StringID string_id; ///< Default name of engine

   114

};

   115

   116

struct Engine {

   117

	char *name;         ///< Custom name of engine

   118

	Date intro_date;

   119

	Date age;

   120

	uint16 reliability;

   121

	uint16 reliability_spd_dec;

   122

	uint16 reliability_start, reliability_max, reliability_final;

   123

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

   124

	byte lifelength;

   125

	byte flags;

   126

	PlayerByte preview_player;

   127

	byte preview_wait;

   128

	byte player_avail;

   129

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

   130

};

   131

   132

/**

   133

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

   134

 */

   135

enum {

   136

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

   137

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

   138

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

   139

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

   140

};

   141

   142

/**

   143

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

   144

 */

   145

enum {

   146

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

   147

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

   148

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

   149

};

   150

   151

enum {

   152

	NUM_VEHICLE_TYPES = 6

   153

};

   154

   155

static const EngineID INVALID_ENGINE = 0xFFFF;

   156

   157

   158

void SetupEngines();

   159

void StartupEngines();

   160

   161

   162

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

   163

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

   164

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

   165

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

   166

   167

void LoadCustomEngineNames();

   168

void DeleteCustomEngineNames();

   169

   170

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

   171

CargoID GetEngineCargoType(EngineID engine);

   172

   173

enum {

   174

	NUM_NORMAL_RAIL_ENGINES = 54,

   175

	NUM_MONORAIL_ENGINES    = 30,

   176

	NUM_MAGLEV_ENGINES      = 32,

   177

	NUM_TRAIN_ENGINES       = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   178

	NUM_ROAD_ENGINES        = 88,

   179

	NUM_SHIP_ENGINES        = 11,

   180

	NUM_AIRCRAFT_ENGINES    = 41,

   181

	TOTAL_NUM_ENGINES       = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   182

	AIRCRAFT_ENGINES_INDEX  = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   183

	SHIP_ENGINES_INDEX      = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   184

	ROAD_ENGINES_INDEX      = NUM_TRAIN_ENGINES,

   185

};

   186

   187

static inline EngineID GetFirstEngineOfType(byte type)

   188

{

   189

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

   190

   191

	return start[type];

   192

}

   193

   194

static inline EngineID GetLastEngineOfType(byte type)

   195

{

   196

	const EngineID end[] = {

   197

		NUM_TRAIN_ENGINES,

   198

		ROAD_ENGINES_INDEX + NUM_ROAD_ENGINES,

   199

		SHIP_ENGINES_INDEX + NUM_SHIP_ENGINES,

   200

		AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES};

   201

   202

	return end[type];

   203

}

   204

   206

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

   207

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

   208

   209

   210

static inline Engine* GetEngine(EngineID i)

   211

{

   212

	assert(i < lengthof(_engines));

   213

	return &_engines[i];

   214

}

   215

   216

static inline bool IsEngineIndex(uint index)

   217

{

   218

	return index < TOTAL_NUM_ENGINES;

   219

}

   220

   221

/* Access Vehicle Data */

   222

extern const EngineInfo _orig_engine_info[TOTAL_NUM_ENGINES];

   223

extern const RailVehicleInfo _orig_rail_vehicle_info[NUM_TRAIN_ENGINES];

   224

extern const ShipVehicleInfo _orig_ship_vehicle_info[NUM_SHIP_ENGINES];

   225

extern const AircraftVehicleInfo _orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   226

extern const RoadVehicleInfo _orig_road_vehicle_info[NUM_ROAD_ENGINES];

   227

   228

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   229

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   230

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   231

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   232

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   233

   234

static inline const EngineInfo *EngInfo(EngineID e)

   235

{

   236

	assert(e < lengthof(_engine_info));

   237

	return &_engine_info[e];

   238

}

   239

   240

static inline const RailVehicleInfo* RailVehInfo(EngineID e)

   241

{

   242

	assert(e < lengthof(_rail_vehicle_info));

   243

	return &_rail_vehicle_info[e];

   244

}

   245

   246

static inline const ShipVehicleInfo* ShipVehInfo(EngineID e)

   247

{

   248

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

   249

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   250

}

   251

   252

static inline const AircraftVehicleInfo* AircraftVehInfo(EngineID e)

   253

{

   254

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

   255

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   256

}

   257

   258

static inline const RoadVehicleInfo* RoadVehInfo(EngineID e)

   259

{

   260

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

   261

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   262

}

   263

   264

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

   265

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

   266

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

   267

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

   268

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

   269

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

   270

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

   271

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

   272

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

   273

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

   274

   275

#endif /* ENGINE_H */