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

	uint16 pow_wag_power;

    19

	byte pow_wag_weight;

    20

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

    21

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

    22

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

    23

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

    25

} RailVehicleInfo;

    26

    27

typedef struct ShipVehicleInfo {

    28

	byte image_index;

    29

	byte base_cost;

    30

	uint16 max_speed;

    31

	byte cargo_type;

    32

	uint16 capacity;

    33

	byte running_cost;

    34

	byte sfx;

    35

	byte refittable;

    36

} ShipVehicleInfo;

    37

    38

typedef struct AircraftVehicleInfo {

    39

	byte image_index;

    40

	byte base_cost;

    41

	byte running_cost;

    42

	byte subtype;

    43

	byte sfx;

    44

	byte acceleration;

    45

	byte max_speed;

    46

	byte mail_capacity;

    47

	uint16 passenger_capacity;

    48

} AircraftVehicleInfo;

    49

    50

typedef struct RoadVehicleInfo {

    51

	byte image_index;

    52

	byte base_cost;

    53

	byte running_cost;

    54

	byte sfx;

    55

	byte max_speed;

    56

	byte capacity;

    57

	byte cargo_type;

    58

} RoadVehicleInfo;

    59

    60

typedef struct EngineInfo {

    61

	uint16 base_intro;

    62

	byte unk2;

    63

	byte lifelength;

    64

	byte base_life;

    65

	byte railtype_climates;

    66

} EngineInfo;

    67

    68

typedef struct Engine {

    69

	uint16 intro_date;

    70

	uint16 age;

    71

	uint16 reliability;

    72

	uint16 reliability_spd_dec;

    73

	uint16 reliability_start, reliability_max, reliability_final;

    74

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

    75

	byte lifelength;

    76

	byte flags;

    77

	PlayerID preview_player;

    78

	byte preview_wait;

    79

	byte railtype;

    80

	PlayerID player_avail;

    81

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

    82

} Engine;

    83

    84

    85

enum {

    86

	RVI_MULTIHEAD = 1,

    87

	RVI_WAGON = 2,

    88

};

    89

    90

enum {

    91

	NUM_VEHICLE_TYPES = 6

    92

};

    93

    94

void AddTypeToEngines(void);

    95

void StartupEngines(void);

    96

    97

enum GlobalCargo {

    98

	GC_PASSENGERS   =   0,

    99

	GC_COAL         =   1,

   100

	GC_MAIL         =   2,

   101

	GC_OIL          =   3,

   102

	GC_LIVESTOCK    =   4,

   103

	GC_GOODS        =   5,

   104

	GC_GRAIN        =   6, // GC_WHEAT / GC_MAIZE

   105

	GC_WOOD         =   7,

   106

	GC_IRON_ORE     =   8,

   107

	GC_STEEL        =   9,

   108

	GC_VALUABLES    =  10, // GC_GOLD / GC_DIAMONDS

   109

	GC_PAPER        =  11,

   110

	GC_FOOD         =  12,

   111

	GC_FRUIT        =  13,

   112

	GC_COPPER_ORE   =  14,

   113

	GC_WATER        =  15,

   114

	GC_RUBBER       =  16,

   115

	GC_SUGAR        =  17,

   116

	GC_TOYS         =  18,

   117

	GC_BATTERIES    =  19,

   118

	GC_CANDY        =  20,

   119

	GC_TOFFEE       =  21,

   120

	GC_COLA         =  22,

   121

	GC_COTTON_CANDY =  23,

   122

	GC_BUBBLES      =  24,

   123

	GC_PLASTIC      =  25,

   124

	GC_FIZZY_DRINKS =  26,

   125

	GC_PAPER_TEMP   =  27,

   126

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

   127

	GC_DEFAULT      =  29,

   128

	GC_PURCHASE     =  30,

   129

	GC_INVALID      = 255,

   130

	NUM_GLOBAL_CID  =  31

   131

};

   132

   133

// This enum lists the implemented callbacks

   134

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

   135

enum CallbackID {

   136

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

   137

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

   138

	CBID_WAGON_POWER = 0x10,

   139

   144

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

   145

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

   146

	CBID_REFIT_CAP = 0x15,

   147

};

   148

   149

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

   150

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

   151

enum CallbackMask {

   152

	CBM_WAGON_POWER = 0,

   154

	CBM_REFIT_CAP = 3,

   155

};

   156

   157

enum {

   158

	CALLBACK_FAILED = 0xFFFF

   159

};

   160

   161

VARDEF const uint32 _default_refitmasks[NUM_VEHICLE_TYPES];

   162

VARDEF const CargoID _global_cargo_id[NUM_LANDSCAPE][NUM_CARGO];

   163

VARDEF const uint32 _landscape_global_cargo_mask[NUM_LANDSCAPE];

   164

VARDEF const CargoID _local_cargo_id_ctype[NUM_GLOBAL_CID];

   165

   166

VARDEF uint32 _engine_refit_masks[256];

   167

VARDEF byte _engine_original_sprites[256];

   168

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

   169

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

   170

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

   171

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

   172

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

   173

bool UsesWagonOverride(const Vehicle *v);

   174

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

   175

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

   176

   177

typedef enum VehicleTrigger {

   178

	VEHICLE_TRIGGER_NEW_CARGO = 1,

   179

	// Externally triggered only for the first vehicle in chain

   180

	VEHICLE_TRIGGER_DEPOT = 2,

   181

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

   182

	VEHICLE_TRIGGER_EMPTY = 4,

   183

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

   184

	VEHICLE_TRIGGER_ANY_NEW_CARGO = 8,

   185

} VehicleTrigger;

   186

void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);

   187

   188

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

   189

StringID GetCustomEngineName(int engine);

   190

   191

   192

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

   193

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

   194

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

   195

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

   196

   197

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

   198

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

   199

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

   200

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

   201

   202

void AcceptEnginePreview(Engine *e, PlayerID player);

   203

   204

void LoadCustomEngineNames(void);

   205

void DeleteCustomEngineNames(void);

   206

   207

bool IsEngineBuildable(uint engine, byte type);

   208

void UnInitNewgrEngines(void);

   209

   210

enum {

   211

	NUM_NORMAL_RAIL_ENGINES = 54,

   212

	NUM_MONORAIL_ENGINES = 30,

   213

	NUM_MAGLEV_ENGINES = 32,

   214

	NUM_TRAIN_ENGINES = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   215

	NUM_ROAD_ENGINES = 88,

   216

	NUM_SHIP_ENGINES = 11,

   217

	NUM_AIRCRAFT_ENGINES = 41,

   218

	TOTAL_NUM_ENGINES = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   219

	AIRCRAFT_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   220

	SHIP_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   221

	ROAD_ENGINES_INDEX = NUM_TRAIN_ENGINES,

   222

};

   223

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   224

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

   225

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

   226

static inline Engine* GetEngine(uint i)

   227

{

   228

  assert(i < lengthof(_engines));

   229

  return &_engines[i];

   230

}

   231

   232

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   233

   234

static inline bool IsEngineIndex(uint index)

   235

{

   236

	return index < TOTAL_NUM_ENGINES;

   237

}

   238

   239

/* Access Vehicle Data */

   240

//#include "table/engines.h"

   241

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   242

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   243

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   244

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   245

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   246

   247

static inline RailVehicleInfo *RailVehInfo(uint e)

   248

{

   249

	assert(e < lengthof(_rail_vehicle_info));

   250

	return &_rail_vehicle_info[e];

   251

}

   252

   253

static inline ShipVehicleInfo *ShipVehInfo(uint e)

   254

{

   255

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

   256

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   257

}

   258

   259

static inline AircraftVehicleInfo *AircraftVehInfo(uint e)

   260

{

   261

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

   262

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   263

}

   264

   265

static inline RoadVehicleInfo *RoadVehInfo(uint e)

   266

{

   267

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

   268

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   269

}

   270

   271

#endif