1

#ifndef ENGINE_H

     2

#define ENGINE_H

     3

     4

#include "sprite.h"

     5

     6

typedef struct RailVehicleInfo {

     7

	byte image_index;

     8

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

     9

	byte base_cost;

    10

	uint16 max_speed;

    11

	uint16 power;

    12

	byte weight;

    13

	byte running_cost_base;

    14

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

    15

	byte capacity;

    16

	byte cargo_type;

    17

	byte callbackmask; // see CallbackMask enum

    18

} RailVehicleInfo;

    19

    20

typedef struct ShipVehicleInfo {

    21

	byte image_index;

    22

	byte base_cost;

    23

	uint16 max_speed;

    24

	byte cargo_type;

    25

	uint16 capacity;

    26

	byte running_cost;

    27

	byte sfx;

    28

	byte refittable;

    29

} ShipVehicleInfo;

    30

    31

typedef struct AircraftVehicleInfo {

    32

	byte image_index;

    33

	byte base_cost;

    34

	byte running_cost;

    35

	byte subtype;

    36

	byte sfx;

    37

	byte acceleration;

    38

	byte max_speed;

    39

	byte mail_capacity;

    40

	uint16 passenger_capacity;

    41

} AircraftVehicleInfo;

    42

    43

typedef struct RoadVehicleInfo {

    44

	byte image_index;

    45

	byte base_cost;

    46

	byte running_cost;

    47

	byte sfx;

    48

	byte max_speed;

    49

	byte capacity;

    50

	byte cargo_type;

    51

} RoadVehicleInfo;

    52

    53

typedef struct EngineInfo {

    54

	uint16 base_intro;

    55

	byte unk2;

    56

	byte lifelength;

    57

	byte base_life;

    58

	byte railtype_climates;

    59

} EngineInfo;

    60

    61

typedef struct Engine {

    62

	uint16 intro_date;

    63

	uint16 age;

    64

	uint16 reliability;

    65

	uint16 reliability_spd_dec;

    66

	uint16 reliability_start, reliability_max, reliability_final;

    67

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

    68

	byte lifelength;

    69

	byte flags;

    70

	PlayerID preview_player;

    71

	byte preview_wait;

    72

	byte railtype;

    73

	PlayerID player_avail;

    74

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

    75

} Engine;

    76

    77

    78

enum {

    79

	RVI_MULTIHEAD = 1,

    80

	RVI_WAGON = 2,

    81

};

    82

    83

enum {

    84

	NUM_VEHICLE_TYPES = 6

    85

};

    86

    87

void AddTypeToEngines(void);

    88

void StartupEngines(void);

    89

    90

enum GlobalCargo {

    91

	GC_PASSENGERS   =   0,

    92

	GC_COAL         =   1,

    93

	GC_MAIL         =   2,

    94

	GC_OIL          =   3,

    95

	GC_LIVESTOCK    =   4,

    96

	GC_GOODS        =   5,

    97

	GC_GRAIN        =   6, // GC_WHEAT / GC_MAIZE

    98

	GC_WOOD         =   7,

    99

	GC_IRON_ORE     =   8,

   100

	GC_STEEL        =   9,

   101

	GC_VALUABLES    =  10, // GC_GOLD / GC_DIAMONDS

   102

	GC_PAPER        =  11,

   103

	GC_FOOD         =  12,

   104

	GC_FRUIT        =  13,

   105

	GC_COPPER_ORE   =  14,

   106

	GC_WATER        =  15,

   107

	GC_RUBBER       =  16,

   108

	GC_SUGAR        =  17,

   109

	GC_TOYS         =  18,

   110

	GC_BATTERIES    =  19,

   111

	GC_CANDY        =  20,

   112

	GC_TOFFEE       =  21,

   113

	GC_COLA         =  22,

   114

	GC_COTTON_CANDY =  23,

   115

	GC_BUBBLES      =  24,

   116

	GC_PLASTIC      =  25,

   117

	GC_FIZZY_DRINKS =  26,

   118

	GC_PAPER_TEMP   =  27,

   119

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

   120

	GC_DEFAULT      =  29,

   121

	GC_PURCHASE     =  30,

   122

	GC_INVALID      = 255,

   123

	NUM_GLOBAL_CID  =  31

   124

};

   125

   126

// This enum lists the implemented callbacks

   127

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

   128

enum CallbackID {

   129

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

   130

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

   131

	CBID_REFIT_CAP = 0x15,

   132

};

   133

   134

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

   135

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

   136

enum CallbackMask {

   137

	CBM_REFIT_CAP = 3,

   138

};

   139

   140

enum {

   141

	CALLBACK_FAILED = 0xFFFF

   142

};

   143

   144

VARDEF const uint32 _default_refitmasks[NUM_VEHICLE_TYPES];

   145

VARDEF const CargoID _global_cargo_id[NUM_LANDSCAPE][NUM_CARGO];

   146

VARDEF const uint32 _landscape_global_cargo_mask[NUM_LANDSCAPE];

   147

VARDEF const CargoID _local_cargo_id_ctype[NUM_GLOBAL_CID];

   148

   149

VARDEF uint32 _engine_refit_masks[256];

   150

VARDEF byte _engine_original_sprites[256];

   151

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

   152

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

   153

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

   154

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

   155

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

   156

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

   157

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

   158

   159

typedef enum VehicleTrigger {

   160

	VEHICLE_TRIGGER_NEW_CARGO = 1,

   161

	// Externally triggered only for the first vehicle in chain

   162

	VEHICLE_TRIGGER_DEPOT = 2,

   163

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

   164

	VEHICLE_TRIGGER_EMPTY = 4,

   165

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

   166

	VEHICLE_TRIGGER_ANY_NEW_CARGO = 8,

   167

} VehicleTrigger;

   168

void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);

   169

   170

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

   171

StringID GetCustomEngineName(int engine);

   172

   173

   174

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

   175

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

   176

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

   177

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

   178

   179

void DrawTrainEngineInfo(int engine, int x, int y, int maxw);

   180

void DrawRoadVehEngineInfo(int engine, int x, int y, int maxw);

   181

void DrawShipEngineInfo(int engine, int x, int y, int maxw);

   182

void DrawAircraftEngineInfo(int engine, int x, int y, int maxw);

   183

   184

void AcceptEnginePreview(Engine *e, PlayerID player);

   185

   186

void LoadCustomEngineNames(void);

   187

void DeleteCustomEngineNames(void);

   188

   189

bool IsEngineBuildable(uint engine, byte type);

   190

void UnInitNewgrEngines(void);

   191

   192

enum {

   193

	NUM_NORMAL_RAIL_ENGINES = 54,

   194

	NUM_MONORAIL_ENGINES = 30,

   195

	NUM_MAGLEV_ENGINES = 32,

   196

	NUM_TRAIN_ENGINES = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   197

	NUM_ROAD_ENGINES = 88,

   198

	NUM_SHIP_ENGINES = 11,

   199

	NUM_AIRCRAFT_ENGINES = 41,

   200

	TOTAL_NUM_ENGINES = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   201

	AIRCRAFT_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   202

	SHIP_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   203

	ROAD_ENGINES_INDEX = NUM_TRAIN_ENGINES,

   204

};

   205

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   206

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

   207

#define DEREF_ENGINE(i) (GetEngine(i))

   208

static inline Engine* GetEngine(uint i)

   209

{

   210

  assert(i < lengthof(_engines));

   211

  return &_engines[i];

   212

}

   213

   214

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   215

   216

static inline bool IsEngineIndex(uint index)

   217

{

   218

	return index < TOTAL_NUM_ENGINES;

   219

}

   220

   221

/* Access Vehicle Data */

   222

//#include "table/engines.h"

   223

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   224

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   225

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   226

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   227

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   228

   229

static inline RailVehicleInfo *RailVehInfo(uint e)

   230

{

   231

	assert(e < lengthof(_rail_vehicle_info));

   232

	return &_rail_vehicle_info[e];

   233

}

   234

   235

static inline ShipVehicleInfo *ShipVehInfo(uint e)

   236

{

   237

	assert(e - SHIP_ENGINES_INDEX < lengthof(_ship_vehicle_info));

   238

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   239

}

   240

   241

static inline AircraftVehicleInfo *AircraftVehInfo(uint e)

   242

{

   243

	assert(e - AIRCRAFT_ENGINES_INDEX < lengthof(_aircraft_vehicle_info));

   244

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   245

}

   246

   247

static inline RoadVehicleInfo *RoadVehInfo(uint e)

   248

{

   249

	assert(e - ROAD_ENGINES_INDEX < lengthof(_road_vehicle_info));

   250

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   251

}

   252

   253

#endif