1

#ifndef ENGINE_H

     2

#define ENGINE_H

     3

     7

#include "sprite.h"

     8

     9

typedef struct RailVehicleInfo {

    10

	byte image_index;

    11

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

    12

	byte base_cost;

    13

	uint16 max_speed;

    14

	uint16 power;

    15

	byte weight;

    16

	byte running_cost_base;

    17

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

    18

	byte capacity;

    19

	byte cargo_type;

    20

	byte callbackmask; // see CallbackMask enum

    21

	uint16 pow_wag_power;

    22

	byte pow_wag_weight;

    23

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

    24

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

    25

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

    26

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

    27

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

    28

} RailVehicleInfo;

    29

    30

typedef struct ShipVehicleInfo {

    31

	byte image_index;

    32

	byte base_cost;

    33

	uint16 max_speed;

    34

	byte cargo_type;

    35

	uint16 capacity;

    36

	byte running_cost;

    37

	byte sfx;

    38

	byte refittable;

    39

} ShipVehicleInfo;

    40

    41

typedef struct AircraftVehicleInfo {

    42

	byte image_index;

    43

	byte base_cost;

    44

	byte running_cost;

    45

	byte subtype;

    46

	byte sfx;

    47

	byte acceleration;

    48

	byte max_speed;

    49

	byte mail_capacity;

    50

	uint16 passenger_capacity;

    51

} AircraftVehicleInfo;

    52

    53

typedef struct RoadVehicleInfo {

    54

	byte image_index;

    55

	byte base_cost;

    56

	byte running_cost;

    57

	byte sfx;

    58

	byte max_speed;

    59

	byte capacity;

    60

	byte cargo_type;

    61

} RoadVehicleInfo;

    62

    66

typedef struct EngineInfo {

    67

	uint16 base_intro;

    69

	byte lifelength;

    70

	byte base_life;

    72

} EngineInfo;

    73

    74

typedef struct Engine {

    75

	uint16 intro_date;

    76

	uint16 age;

    77

	uint16 reliability;

    78

	uint16 reliability_spd_dec;

    79

	uint16 reliability_start, reliability_max, reliability_final;

    80

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

    81

	byte lifelength;

    82

	byte flags;

    83

	PlayerID preview_player;

    84

	byte preview_wait;

    85

	byte railtype;

    86

	PlayerID player_avail;

    87

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

    88

} Engine;

    89

    90

    91

enum {

    92

	RVI_MULTIHEAD = 1,

    93

	RVI_WAGON = 2,

    94

};

    95

    96

enum {

    97

	NUM_VEHICLE_TYPES = 6

    98

};

    99

   100

void AddTypeToEngines(void);

   101

void StartupEngines(void);

   102

   103

enum GlobalCargo {

   104

	GC_PASSENGERS   =   0,

   105

	GC_COAL         =   1,

   106

	GC_MAIL         =   2,

   107

	GC_OIL          =   3,

   108

	GC_LIVESTOCK    =   4,

   109

	GC_GOODS        =   5,

   110

	GC_GRAIN        =   6, // GC_WHEAT / GC_MAIZE

   111

	GC_WOOD         =   7,

   112

	GC_IRON_ORE     =   8,

   113

	GC_STEEL        =   9,

   114

	GC_VALUABLES    =  10, // GC_GOLD / GC_DIAMONDS

   115

	GC_PAPER        =  11,

   116

	GC_FOOD         =  12,

   117

	GC_FRUIT        =  13,

   118

	GC_COPPER_ORE   =  14,

   119

	GC_WATER        =  15,

   120

	GC_RUBBER       =  16,

   121

	GC_SUGAR        =  17,

   122

	GC_TOYS         =  18,

   123

	GC_BATTERIES    =  19,

   124

	GC_CANDY        =  20,

   125

	GC_TOFFEE       =  21,

   126

	GC_COLA         =  22,

   127

	GC_COTTON_CANDY =  23,

   128

	GC_BUBBLES      =  24,

   129

	GC_PLASTIC      =  25,

   130

	GC_FIZZY_DRINKS =  26,

   131

	GC_PAPER_TEMP   =  27,

   132

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

   133

	GC_DEFAULT      =  29,

   134

	GC_PURCHASE     =  30,

   135

	GC_INVALID      = 255,

   136

	NUM_GLOBAL_CID  =  31

   137

};

   138

   139

// This enum lists the implemented callbacks

   140

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

   141

enum CallbackID {

   142

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

   143

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

   144

	CBID_WAGON_POWER = 0x10,

   145

   146

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

   147

	// only for train vehicles

   148

	CBID_VEH_LENGTH = 0x11,

   149

   150

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

   151

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

   152

	CBID_REFIT_CAP = 0x15,

   153

};

   154

   155

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

   156

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

   157

enum CallbackMask {

   158

	CBM_WAGON_POWER = 0,

   159

	CBM_VEH_LENGTH = 1,

   160

	CBM_REFIT_CAP = 3,

   161

};

   162

   163

enum {

   164

	CALLBACK_FAILED = 0xFFFF

   165

};

   166

   167

VARDEF const uint32 _default_refitmasks[NUM_VEHICLE_TYPES];

   168

VARDEF const CargoID _global_cargo_id[NUM_LANDSCAPE][NUM_CARGO];

   169

VARDEF const uint32 _landscape_global_cargo_mask[NUM_LANDSCAPE];

   170

VARDEF const CargoID _local_cargo_id_ctype[NUM_GLOBAL_CID];

   171

   172

VARDEF uint32 _engine_refit_masks[256];

   173

VARDEF byte _engine_original_sprites[256];

   174

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

   175

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

   176

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

   177

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

   178

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

   179

bool UsesWagonOverride(const Vehicle *v);

   180

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

   181

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

   182

   183

typedef enum VehicleTrigger {

   184

	VEHICLE_TRIGGER_NEW_CARGO = 1,

   185

	// Externally triggered only for the first vehicle in chain

   186

	VEHICLE_TRIGGER_DEPOT = 2,

   187

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

   188

	VEHICLE_TRIGGER_EMPTY = 4,

   189

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

   190

	VEHICLE_TRIGGER_ANY_NEW_CARGO = 8,

   191

} VehicleTrigger;

   192

void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);

   193

   194

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

   195

StringID GetCustomEngineName(int engine);

   196

   197

   198

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

   199

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

   200

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

   201

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

   202

   203

void AcceptEnginePreview(Engine *e, PlayerID player);

   204

   205

void LoadCustomEngineNames(void);

   206

void DeleteCustomEngineNames(void);

   207

   208

bool IsEngineBuildable(uint engine, byte type);

   209

void UnInitNewgrEngines(void);

   210

   211

enum {

   212

	NUM_NORMAL_RAIL_ENGINES = 54,

   213

	NUM_MONORAIL_ENGINES = 30,

   214

	NUM_MAGLEV_ENGINES = 32,

   215

	NUM_TRAIN_ENGINES = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   216

	NUM_ROAD_ENGINES = 88,

   217

	NUM_SHIP_ENGINES = 11,

   218

	NUM_AIRCRAFT_ENGINES = 41,

   219

	TOTAL_NUM_ENGINES = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   220

	AIRCRAFT_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   221

	SHIP_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   222

	ROAD_ENGINES_INDEX = NUM_TRAIN_ENGINES,

   223

};

   224

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   225

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

   226

   227

static inline Engine* GetEngine(uint i)

   228

{

   229

  assert(i < lengthof(_engines));

   230

  return &_engines[i];

   231

}

   232

   233

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   234

   235

static inline bool IsEngineIndex(uint index)

   236

{

   237

	return index < TOTAL_NUM_ENGINES;

   238

}

   239

   240

/* Access Vehicle Data */

   241

//#include "table/engines.h"

   242

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   243

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   244

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   245

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   246

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   247

   248

static inline RailVehicleInfo *RailVehInfo(uint e)

   249

{

   250

	assert(e < lengthof(_rail_vehicle_info));

   251

	return &_rail_vehicle_info[e];

   252

}

   253

   254

static inline ShipVehicleInfo *ShipVehInfo(uint e)

   255

{

   256

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

   257

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   258

}

   259

   260

static inline AircraftVehicleInfo *AircraftVehInfo(uint e)

   261

{

   262

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

   263

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   264

}

   265

   266

static inline RoadVehicleInfo *RoadVehInfo(uint e)

   267

{

   268

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

   269

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   270

}

   271

   272

#endif