1

/* $Id$ */

     2

     3

#ifndef ENGINE_H

     4

#define ENGINE_H

     5

     6

/** @file engine.h

     7

  */

     8

     9

#include "sprite.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 engclass; // 0: steam, 1: diesel, 2: electric

    20

	byte capacity;

    21

	byte cargo_type;

    22

	byte callbackmask; // see CallbackMask enum

    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

} RailVehicleInfo;

    31

    32

typedef struct ShipVehicleInfo {

    33

	byte image_index;

    34

	byte base_cost;

    35

	uint16 max_speed;

    36

	byte cargo_type;

    37

	uint16 capacity;

    38

	byte running_cost;

    39

	byte sfx;

    40

	byte refittable;

    41

} ShipVehicleInfo;

    42

    43

typedef struct AircraftVehicleInfo {

    44

	byte image_index;

    45

	byte base_cost;

    46

	byte running_cost;

    47

	byte subtype;

    48

	byte sfx;

    49

	byte acceleration;

    50

	byte max_speed;

    51

	byte mail_capacity;

    52

	uint16 passenger_capacity;

    53

} AircraftVehicleInfo;

    54

    55

typedef struct RoadVehicleInfo {

    56

	byte image_index;

    57

	byte base_cost;

    58

	byte running_cost;

    59

	byte sfx;

    60

	byte max_speed;

    61

	byte capacity;

    62

	byte cargo_type;

    63

} RoadVehicleInfo;

    64

    65

/** Information about a vehicle

    66

  * @see table/engines.h

    67

  */

    68

typedef struct EngineInfo {

    69

	uint16 base_intro;

    70

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

    71

	byte lifelength;

    72

	byte base_life;

    73

	byte railtype:4;

    74

	byte climates:4;

    75

	uint32 refit_mask;

    76

} EngineInfo;

    77

    78

typedef struct Engine {

    79

	uint16 intro_date;

    80

	uint16 age;

    81

	uint16 reliability;

    82

	uint16 reliability_spd_dec;

    83

	uint16 reliability_start, reliability_max, reliability_final;

    84

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

    85

	byte lifelength;

    86

	byte flags;

    87

	byte preview_player;

    88

	byte preview_wait;

    89

	byte railtype;

    90

	byte player_avail;

    91

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

    92

} Engine;

    93

    94

    95

enum {

    96

	RVI_MULTIHEAD = 1,

    97

	RVI_WAGON = 2,

    98

};

    99

   100

enum {

   101

	NUM_VEHICLE_TYPES = 6

   102

};

   103

   104

void AddTypeToEngines(void);

   105

void StartupEngines(void);

   106

   107

enum GlobalCargo {

   108

	GC_PASSENGERS   =   0,

   109

	GC_COAL         =   1,

   110

	GC_MAIL         =   2,

   111

	GC_OIL          =   3,

   112

	GC_LIVESTOCK    =   4,

   113

	GC_GOODS        =   5,

   114

	GC_GRAIN        =   6, // GC_WHEAT / GC_MAIZE

   115

	GC_WOOD         =   7,

   116

	GC_IRON_ORE     =   8,

   117

	GC_STEEL        =   9,

   118

	GC_VALUABLES    =  10, // GC_GOLD / GC_DIAMONDS

   119

	GC_PAPER        =  11,

   120

	GC_FOOD         =  12,

   121

	GC_FRUIT        =  13,

   122

	GC_COPPER_ORE   =  14,

   123

	GC_WATER        =  15,

   124

	GC_RUBBER       =  16,

   125

	GC_SUGAR        =  17,

   126

	GC_TOYS         =  18,

   127

	GC_BATTERIES    =  19,

   128

	GC_CANDY        =  20,

   129

	GC_TOFFEE       =  21,

   130

	GC_COLA         =  22,

   131

	GC_COTTON_CANDY =  23,

   132

	GC_BUBBLES      =  24,

   133

	GC_PLASTIC      =  25,

   134

	GC_FIZZY_DRINKS =  26,

   135

	GC_PAPER_TEMP   =  27,

   136

	GC_UNDEFINED    =  28, // undefined; unused slot in arctic climate

   137

	GC_DEFAULT      =  29,

   138

	GC_PURCHASE     =  30,

   139

	GC_INVALID      = 255,

   140

	NUM_GLOBAL_CID  =  31

   141

};

   142

   143

// This enum lists the implemented callbacks

   144

// Use as argument for the GetCallBackResult function (see comments there)

   145

enum CallbackID {

   146

	// Powered wagons, if the result is lower as 0x40 then the wagon is powered

   147

	// TODO: interpret the rest of the result, aka "visual effects"

   148

	CBID_WAGON_POWER = 0x10,

   149

   150

	// Vehicle length, returns the amount of 1/8's the vehicle is shorter

   151

	// only for train vehicles

   152

	CBID_VEH_LENGTH = 0x11,

   153

   154

	// Refit capacity, the passed vehicle needs to have its ->cargo_type set to

   155

	// the cargo we are refitting to, returns the new cargo capacity

   156

	CBID_REFIT_CAP = 0x15,

   157

   158

	CBID_ARTIC_ENGINE = 0x16,

   159

};

   160

   161

// bit positions for rvi->callbackmask, indicates which callbacks are used by an engine

   162

// (some callbacks are always used, and dont appear here)

   163

enum CallbackMask {

   164

	CBM_WAGON_POWER = 0,

   165

	CBM_VEH_LENGTH = 1,

   166

	CBM_REFIT_CAP = 3,

   167

	CBM_ARTIC_ENGINE = 4,

   168

};

   169

   170

enum {

   171

	CALLBACK_FAILED = 0xFFFF

   172

};

   173

   174

VARDEF const uint32 _default_refitmasks[NUM_VEHICLE_TYPES];

   175

VARDEF const CargoID _global_cargo_id[NUM_LANDSCAPE][NUM_CARGO];

   176

VARDEF const uint32 _landscape_global_cargo_mask[NUM_LANDSCAPE];

   177

VARDEF const CargoID _local_cargo_id_ctype[NUM_GLOBAL_CID];

   178

VARDEF const uint32 cargo_classes[16];

   179

   180

void SetWagonOverrideSprites(EngineID engine, struct SpriteGroup *group, byte *train_id, int trains);

   181

void SetCustomEngineSprites(EngineID engine, byte cargo, struct SpriteGroup *group);

   182

// loaded is in percents, overriding_engine 0xffff is none

   183

int GetCustomEngineSprite(EngineID engine, const Vehicle *v, byte direction);

   184

uint16 GetCallBackResult(uint16 callback_info, EngineID engine, const Vehicle *v);

   185

bool UsesWagonOverride(const Vehicle *v);

   186

#define GetCustomVehicleSprite(v, direction) GetCustomEngineSprite(v->engine_type, v, direction)

   187

#define GetCustomVehicleIcon(et, direction) GetCustomEngineSprite(et, NULL, direction)

   188

   189

typedef enum VehicleTrigger {

   190

	VEHICLE_TRIGGER_NEW_CARGO = 1,

   191

	// Externally triggered only for the first vehicle in chain

   192

	VEHICLE_TRIGGER_DEPOT = 2,

   193

	// Externally triggered only for the first vehicle in chain, only if whole chain is empty

   194

	VEHICLE_TRIGGER_EMPTY = 4,

   195

	// Not triggered externally (called for the whole chain if we got NEW_CARGO)

   196

	VEHICLE_TRIGGER_ANY_NEW_CARGO = 8,

   197

} VehicleTrigger;

   198

void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);

   199

   200

void SetCustomEngineName(EngineID engine, const char *name);

   201

StringID GetCustomEngineName(EngineID engine);

   202

   203

   204

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

   205

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

   206

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

   207

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

   208

   209

void AcceptEnginePreview(Engine *e, PlayerID player);

   210

   211

void LoadCustomEngineNames(void);

   212

void DeleteCustomEngineNames(void);

   213

   214

bool IsEngineBuildable(uint engine, byte type);

   215

void UnInitNewgrEngines(void);

   216

   217

enum {

   218

	NUM_NORMAL_RAIL_ENGINES = 54,

   219

	NUM_MONORAIL_ENGINES = 30,

   220

	NUM_MAGLEV_ENGINES = 32,

   221

	NUM_TRAIN_ENGINES = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   222

	NUM_ROAD_ENGINES = 88,

   223

	NUM_SHIP_ENGINES = 11,

   224

	NUM_AIRCRAFT_ENGINES = 41,

   225

	TOTAL_NUM_ENGINES = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   226

	AIRCRAFT_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   227

	SHIP_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   228

	ROAD_ENGINES_INDEX = NUM_TRAIN_ENGINES,

   229

};

   230

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   231

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

   232

   233

static inline Engine* GetEngine(EngineID i)

   234

{

   235

  assert(i < lengthof(_engines));

   236

  return &_engines[i];

   237

}

   238

   239

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   240

   241

static inline bool IsEngineIndex(uint index)

   242

{

   243

	return index < TOTAL_NUM_ENGINES;

   244

}

   245

   246

/* Access Vehicle Data */

   247

//#include "table/engines.h"

   248

extern const EngineInfo orig_engine_info[TOTAL_NUM_ENGINES];

   249

extern const RailVehicleInfo orig_rail_vehicle_info[NUM_TRAIN_ENGINES];

   250

extern const ShipVehicleInfo orig_ship_vehicle_info[NUM_SHIP_ENGINES];

   251

extern const AircraftVehicleInfo orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   252

extern const RoadVehicleInfo orig_road_vehicle_info[NUM_ROAD_ENGINES];

   253

   259

   260

static inline const RailVehicleInfo* RailVehInfo(EngineID e)

   261

{

   262

	assert(e < lengthof(_rail_vehicle_info));

   263

	return &_rail_vehicle_info[e];

   264

}

   265

   266

static inline const ShipVehicleInfo* ShipVehInfo(EngineID e)

   267

{

   268

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

   269

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   270

}

   271

   272

static inline const AircraftVehicleInfo* AircraftVehInfo(EngineID e)

   273

{

   274

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

   275

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   276

}

   277

   278

static inline const RoadVehicleInfo* RoadVehInfo(EngineID e)

   279

{

   280

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

   281

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   282

}

   283

   284

void UnloadWagonOverrides(void);

   285

void UnloadCustomEngineSprites(void);

   286

   287

#endif /* ENGINE_H */