truelight@0: #ifndef ENGINE_H
truelight@0: #define ENGINE_H
truelight@0: 
darkvater@405: #include "sprite.h"
darkvater@405: 
truelight@0: typedef struct RailVehicleInfo {
truelight@0: 	byte image_index;
truelight@0: 	byte flags; /* 1=multihead engine, 2=wagon */
truelight@0: 	byte base_cost;
truelight@0: 	uint16 max_speed;
truelight@0: 	uint16 power;
truelight@0: 	byte weight;
truelight@0: 	byte running_cost_base;
truelight@0: 	byte engclass; // 0: steam, 1: diesel, 2: electric
truelight@0: 	byte capacity;
truelight@0: 	byte cargo_type;
hackykid@1895: 	byte callbackmask; // see CallbackMask enum
hackykid@1908: 	uint16 pow_wag_power;
hackykid@1908: 	byte pow_wag_weight;
hackykid@1908: 	byte visual_effect; // NOTE: this is not 100% implemented yet, at the moment it is only used as a 'fallback' value
hackykid@1908: 	                    //       for when the 'powered wagon' callback fails. But it should really also determine what
hackykid@1908: 	                    //       kind of visual effect to generate for a vehicle (default, steam, diesel, electric).
hackykid@1908: 	                    //       Same goes for the callback result, which atm is only used to check if a wagon is powered.
hackykid@1922: 	byte shorten_factor;	// length on main map for this type is 8 - shorten_factor
truelight@0: } RailVehicleInfo;
truelight@0: 
truelight@0: typedef struct ShipVehicleInfo {
truelight@0: 	byte image_index;
truelight@0: 	byte base_cost;
truelight@0: 	uint16 max_speed;
truelight@0: 	byte cargo_type;
truelight@0: 	uint16 capacity;
truelight@0: 	byte running_cost;
truelight@0: 	byte sfx;
truelight@0: 	byte refittable;
truelight@0: } ShipVehicleInfo;
truelight@0: 
darkvater@376: typedef struct AircraftVehicleInfo {
darkvater@376: 	byte image_index;
darkvater@376: 	byte base_cost;
darkvater@376: 	byte running_cost;
darkvater@376: 	byte subtype;
darkvater@376: 	byte sfx;
darkvater@376: 	byte acceleration;
darkvater@376: 	byte max_speed;
darkvater@376: 	byte mail_capacity;
celestar@922: 	uint16 passenger_capacity;
darkvater@376: } AircraftVehicleInfo;
darkvater@376: 
darkvater@376: typedef struct RoadVehicleInfo {
darkvater@376: 	byte image_index;
darkvater@376: 	byte base_cost;
darkvater@376: 	byte running_cost;
darkvater@376: 	byte sfx;
darkvater@376: 	byte max_speed;
darkvater@376: 	byte capacity;
darkvater@376: 	byte cargo_type;
darkvater@376: } RoadVehicleInfo;
truelight@0: 
truelight@0: typedef struct EngineInfo {
truelight@0: 	uint16 base_intro;
truelight@0: 	byte unk2;
truelight@0: 	byte lifelength;
truelight@0: 	byte base_life;
truelight@0: 	byte railtype_climates;
truelight@0: } EngineInfo;
truelight@0: 
truelight@0: typedef struct Engine {
truelight@0: 	uint16 intro_date;
truelight@0: 	uint16 age;
truelight@0: 	uint16 reliability;
truelight@0: 	uint16 reliability_spd_dec;
truelight@0: 	uint16 reliability_start, reliability_max, reliability_final;
truelight@0: 	uint16 duration_phase_1, duration_phase_2, duration_phase_3;
truelight@0: 	byte lifelength;
truelight@0: 	byte flags;
Darkvater@1786: 	PlayerID preview_player;
truelight@0: 	byte preview_wait;
truelight@0: 	byte railtype;
Darkvater@1786: 	PlayerID player_avail;
bjarni@819: 	byte type;				// type, ie VEH_Road, VEH_Train, etc. Same as in vehicle.h
truelight@0: } Engine;
truelight@0: 
truelight@0: 
truelight@0: enum {
truelight@0: 	RVI_MULTIHEAD = 1,
truelight@0: 	RVI_WAGON = 2,
truelight@0: };
truelight@0: 
Darkvater@1802: enum {
Darkvater@1802: 	NUM_VEHICLE_TYPES = 6
Darkvater@1802: };
truelight@0: 
tron@1093: void AddTypeToEngines(void);
tron@1093: void StartupEngines(void);
truelight@0: 
Darkvater@1802: enum GlobalCargo {
Darkvater@1802: 	GC_PASSENGERS   =   0,
Darkvater@1802: 	GC_COAL         =   1,
Darkvater@1802: 	GC_MAIL         =   2,
Darkvater@1802: 	GC_OIL          =   3,
Darkvater@1802: 	GC_LIVESTOCK    =   4,
Darkvater@1802: 	GC_GOODS        =   5,
Darkvater@1802: 	GC_GRAIN        =   6, // GC_WHEAT / GC_MAIZE
Darkvater@1802: 	GC_WOOD         =   7,
Darkvater@1802: 	GC_IRON_ORE     =   8,
Darkvater@1802: 	GC_STEEL        =   9,
Darkvater@1802: 	GC_VALUABLES    =  10, // GC_GOLD / GC_DIAMONDS
Darkvater@1802: 	GC_PAPER        =  11,
Darkvater@1802: 	GC_FOOD         =  12,
Darkvater@1802: 	GC_FRUIT        =  13,
Darkvater@1802: 	GC_COPPER_ORE   =  14,
Darkvater@1802: 	GC_WATER        =  15,
Darkvater@1802: 	GC_RUBBER       =  16,
Darkvater@1802: 	GC_SUGAR        =  17,
Darkvater@1802: 	GC_TOYS         =  18,
Darkvater@1802: 	GC_BATTERIES    =  19,
Darkvater@1802: 	GC_CANDY        =  20,
Darkvater@1802: 	GC_TOFFEE       =  21,
Darkvater@1802: 	GC_COLA         =  22,
Darkvater@1802: 	GC_COTTON_CANDY =  23,
Darkvater@1802: 	GC_BUBBLES      =  24,
Darkvater@1802: 	GC_PLASTIC      =  25,
Darkvater@1802: 	GC_FIZZY_DRINKS =  26,
Darkvater@1802: 	GC_PAPER_TEMP   =  27,
Darkvater@1802: 	GC_UNDEFINED    =  28, // undefined; unused slot in arctic climate
Darkvater@1802: 	GC_DEFAULT      =  29,
Darkvater@1802: 	GC_PURCHASE     =  30,
Darkvater@1802: 	GC_INVALID      = 255,
Darkvater@1802: 	NUM_GLOBAL_CID  =  31
Darkvater@1802: };
truelight@0: 
hackykid@1895: // This enum lists the implemented callbacks
hackykid@1895: // Use as argument for the GetCallBackResult function (see comments there)
hackykid@1883: enum CallbackID {
hackykid@1908: 	// Powered wagons, if the result is lower as 0x40 then the wagon is powered
hackykid@1908: 	// TODO: interpret the rest of the result, aka "visual effects"
hackykid@1908: 	CBID_WAGON_POWER = 0x10,
hackykid@1908: 
hackykid@1922: 	// Vehicle length, returns the amount of 1/8's the vehicle is shorter
hackykid@1922: 	// only for train vehicles
hackykid@1922: 	CBID_VEH_LENGTH = 0x11,
hackykid@1922: 
hackykid@1883: 	// Refit capacity, the passed vehicle needs to have its ->cargo_type set to
hackykid@1883: 	// the cargo we are refitting to, returns the new cargo capacity
hackykid@1895: 	CBID_REFIT_CAP = 0x15,
hackykid@1895: };
hackykid@1895: 
hackykid@1895: // bit positions for rvi->callbackmask, indicates which callbacks are used by an engine
hackykid@1895: // (some callbacks are always used, and dont appear here)
hackykid@1895: enum CallbackMask {
hackykid@1909: 	CBM_WAGON_POWER = 0,
hackykid@1922: 	CBM_VEH_LENGTH = 1,
hackykid@1895: 	CBM_REFIT_CAP = 3,
hackykid@1883: };
hackykid@1883: 
hackykid@1883: enum {
hackykid@1883: 	CALLBACK_FAILED = 0xFFFF
hackykid@1883: };
hackykid@1883: 
Darkvater@1802: VARDEF const uint32 _default_refitmasks[NUM_VEHICLE_TYPES];
Darkvater@1802: VARDEF const CargoID _global_cargo_id[NUM_LANDSCAPE][NUM_CARGO];
Darkvater@1802: VARDEF const uint32 _landscape_global_cargo_mask[NUM_LANDSCAPE];
Darkvater@1802: VARDEF const CargoID _local_cargo_id_ctype[NUM_GLOBAL_CID];
truelight@0: 
Darkvater@1802: VARDEF uint32 _engine_refit_masks[256];
Darkvater@1802: VARDEF byte _engine_original_sprites[256];
darkvater@369: void SetWagonOverrideSprites(byte engine, struct SpriteGroup *group, byte *train_id, int trains);
darkvater@369: void SetCustomEngineSprites(byte engine, byte cargo, struct SpriteGroup *group);
truelight@0: // loaded is in percents, overriding_engine 0xffff is none
tron@1475: int GetCustomEngineSprite(byte engine, const Vehicle *v, byte direction);
hackykid@1883: uint16 GetCallBackResult(uint16 callback_info, byte engine, const Vehicle *v);
hackykid@1908: bool UsesWagonOverride(const Vehicle *v);
darkvater@414: #define GetCustomVehicleSprite(v, direction) GetCustomEngineSprite(v->engine_type, v, direction)
darkvater@414: #define GetCustomVehicleIcon(et, direction) GetCustomEngineSprite(et, NULL, direction)
truelight@0: 
tron@1477: typedef enum VehicleTrigger {
tron@445: 	VEHICLE_TRIGGER_NEW_CARGO = 1,
tron@445: 	// Externally triggered only for the first vehicle in chain
tron@445: 	VEHICLE_TRIGGER_DEPOT = 2,
tron@445: 	// Externally triggered only for the first vehicle in chain, only if whole chain is empty
tron@445: 	VEHICLE_TRIGGER_EMPTY = 4,
tron@445: 	// Not triggered externally (called for the whole chain if we got NEW_CARGO)
tron@445: 	VEHICLE_TRIGGER_ANY_NEW_CARGO = 8,
tron@1477: } VehicleTrigger;
tron@1477: void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);
tron@445: 
tron@1329: void SetCustomEngineName(int engine, const char *name);
truelight@0: StringID GetCustomEngineName(int engine);
truelight@0: 
truelight@0: 
truelight@0: void DrawTrainEngine(int x, int y, int engine, uint32 image_ormod);
truelight@0: void DrawRoadVehEngine(int x, int y, int engine, uint32 image_ormod);
truelight@0: void DrawShipEngine(int x, int y, int engine, uint32 image_ormod);
truelight@0: void DrawAircraftEngine(int x, int y, int engine, uint32 image_ormod);
truelight@0: 
truelight@0: void DrawTrainEngineInfo(int engine, int x, int y, int maxw);
truelight@0: void DrawRoadVehEngineInfo(int engine, int x, int y, int maxw);
truelight@0: void DrawShipEngineInfo(int engine, int x, int y, int maxw);
truelight@0: void DrawAircraftEngineInfo(int engine, int x, int y, int maxw);
truelight@0: 
Darkvater@1786: void AcceptEnginePreview(Engine *e, PlayerID player);
truelight@0: 
tron@1093: void LoadCustomEngineNames(void);
tron@1093: void DeleteCustomEngineNames(void);
truelight@0: 
tron@1197: bool IsEngineBuildable(uint engine, byte type);
Darkvater@1474: void UnInitNewgrEngines(void);
truelight@0: 
truelight@0: enum {
truelight@0: 	NUM_NORMAL_RAIL_ENGINES = 54,
truelight@0: 	NUM_MONORAIL_ENGINES = 30,
truelight@0: 	NUM_MAGLEV_ENGINES = 32,
truelight@0: 	NUM_TRAIN_ENGINES = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,
truelight@0: 	NUM_ROAD_ENGINES = 88,
truelight@0: 	NUM_SHIP_ENGINES = 11,
truelight@0: 	NUM_AIRCRAFT_ENGINES = 41,
darkvater@376: 	TOTAL_NUM_ENGINES = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,
truelight@0: 	AIRCRAFT_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,
truelight@0: 	SHIP_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,
truelight@0: 	ROAD_ENGINES_INDEX = NUM_TRAIN_ENGINES,
truelight@0: };
truelight@0: VARDEF Engine _engines[TOTAL_NUM_ENGINES];
Darkvater@1786: #define FOR_ALL_ENGINES(e) for (e = _engines; e != endof(_engines); e++)
tron@1926: 
Darkvater@1786: static inline Engine* GetEngine(uint i)
Darkvater@1786: {
Darkvater@1786:   assert(i < lengthof(_engines));
Darkvater@1786:   return &_engines[i];
Darkvater@1786: }
Darkvater@1786: 
truelight@0: VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];
truelight@0: 
Darkvater@1786: static inline bool IsEngineIndex(uint index)
Darkvater@1786: {
Darkvater@1786: 	return index < TOTAL_NUM_ENGINES;
Darkvater@1786: }
Darkvater@1786: 
darkvater@376: /* Access Vehicle Data */
darkvater@376: //#include "table/engines.h"
truelight@0: extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];
darkvater@376: extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];
darkvater@376: extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];
darkvater@376: extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];
darkvater@376: extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];
tron@538: 
tron@539: static inline RailVehicleInfo *RailVehInfo(uint e)
tron@538: {
tron@538: 	assert(e < lengthof(_rail_vehicle_info));
tron@538: 	return &_rail_vehicle_info[e];
tron@538: }
tron@538: 
tron@538: static inline ShipVehicleInfo *ShipVehInfo(uint e)
tron@538: {
tron@538: 	assert(e - SHIP_ENGINES_INDEX < lengthof(_ship_vehicle_info));
tron@538: 	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];
tron@538: }
tron@538: 
tron@538: static inline AircraftVehicleInfo *AircraftVehInfo(uint e)
tron@538: {
tron@538: 	assert(e - AIRCRAFT_ENGINES_INDEX < lengthof(_aircraft_vehicle_info));
tron@538: 	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];
tron@538: }
tron@538: 
tron@538: static inline RoadVehicleInfo *RoadVehInfo(uint e)
tron@538: {
tron@538: 	assert(e - ROAD_ENGINES_INDEX < lengthof(_road_vehicle_info));
tron@538: 	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];
tron@538: }
darkvater@405: 
truelight@0: #endif