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

} RailVehicleInfo;

    18

    19

typedef struct ShipVehicleInfo {

    20

	byte image_index;

    21

	byte base_cost;

    22

	uint16 max_speed;

    23

	byte cargo_type;

    24

	uint16 capacity;

    25

	byte running_cost;

    26

	byte sfx;

    27

	byte refittable;

    28

} ShipVehicleInfo;

    29

    30

typedef struct AircraftVehicleInfo {

    31

	byte image_index;

    32

	byte base_cost;

    33

	byte running_cost;

    34

	byte subtype;

    35

	byte sfx;

    36

	byte acceleration;

    37

	byte max_speed;

    38

	byte mail_capacity;

    39

	uint16 passenger_capacity;

    40

} AircraftVehicleInfo;

    41

    42

typedef struct RoadVehicleInfo {

    43

	byte image_index;

    44

	byte base_cost;

    45

	byte running_cost;

    46

	byte sfx;

    47

	byte max_speed;

    48

	byte capacity;

    49

	byte cargo_type;

    50

} RoadVehicleInfo;

    51

    52

typedef struct EngineInfo {

    53

	uint16 base_intro;

    54

	byte unk2;

    55

	byte lifelength;

    56

	byte base_life;

    57

	byte railtype_climates;

    58

} EngineInfo;

    59

    60

typedef struct Engine {

    61

	uint16 intro_date;

    62

	uint16 age;

    63

	uint16 reliability;

    64

	uint16 reliability_spd_dec;

    65

	uint16 reliability_start, reliability_max, reliability_final;

    66

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

    67

	byte lifelength;

    68

	byte flags;

    69

	PlayerID preview_player;

    70

	byte preview_wait;

    71

	byte railtype;

    72

	PlayerID player_avail;

    73

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

    74

} Engine;

    75

    76

    77

enum {

    78

	RVI_MULTIHEAD = 1,

    79

	RVI_WAGON = 2,

    80

};

    81

    85

    86

void AddTypeToEngines(void);

    87

void StartupEngines(void);

    88

   124

   129

   132

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

   133

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

   134

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

   135

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

   136

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

   137

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

   138

   139

typedef enum VehicleTrigger {

   140

	VEHICLE_TRIGGER_NEW_CARGO = 1,

   141

	// Externally triggered only for the first vehicle in chain

   142

	VEHICLE_TRIGGER_DEPOT = 2,

   143

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

   144

	VEHICLE_TRIGGER_EMPTY = 4,

   145

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

   146

	VEHICLE_TRIGGER_ANY_NEW_CARGO = 8,

   147

} VehicleTrigger;

   148

void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);

   149

   150

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

   151

StringID GetCustomEngineName(int engine);

   152

   153

   154

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

   155

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

   156

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

   157

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

   158

   159

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

   160

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

   161

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

   162

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

   163

   164

void AcceptEnginePreview(Engine *e, PlayerID player);

   165

   166

void LoadCustomEngineNames(void);

   167

void DeleteCustomEngineNames(void);

   168

   169

bool IsEngineBuildable(uint engine, byte type);

   170

void UnInitNewgrEngines(void);

   171

   172

enum {

   173

	NUM_NORMAL_RAIL_ENGINES = 54,

   174

	NUM_MONORAIL_ENGINES = 30,

   175

	NUM_MAGLEV_ENGINES = 32,

   176

	NUM_TRAIN_ENGINES = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   177

	NUM_ROAD_ENGINES = 88,

   178

	NUM_SHIP_ENGINES = 11,

   179

	NUM_AIRCRAFT_ENGINES = 41,

   180

	TOTAL_NUM_ENGINES = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   181

	AIRCRAFT_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   182

	SHIP_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   183

	ROAD_ENGINES_INDEX = NUM_TRAIN_ENGINES,

   184

};

   185

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   186

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

   187

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

   188

static inline Engine* GetEngine(uint i)

   189

{

   190

  assert(i < lengthof(_engines));

   191

  return &_engines[i];

   192

}

   193

   194

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   195

   196

static inline bool IsEngineIndex(uint index)

   197

{

   198

	return index < TOTAL_NUM_ENGINES;

   199

}

   200

   201

/* Access Vehicle Data */

   202

//#include "table/engines.h"

   203

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   204

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   205

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   206

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   207

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   208

   209

static inline RailVehicleInfo *RailVehInfo(uint e)

   210

{

   211

	assert(e < lengthof(_rail_vehicle_info));

   212

	return &_rail_vehicle_info[e];

   213

}

   214

   215

static inline ShipVehicleInfo *ShipVehInfo(uint e)

   216

{

   217

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

   218

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   219

}

   220

   221

static inline AircraftVehicleInfo *AircraftVehInfo(uint e)

   222

{

   223

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

   224

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   225

}

   226

   227

static inline RoadVehicleInfo *RoadVehInfo(uint e)

   228

{

   229

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

   230

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   231

}

   232

   233

#endif