tron@2186: /* $Id$ */
tron@2186: 
belugas@6451: /** @file engine.h */
belugas@6451: 
truelight@0: #ifndef ENGINE_H
truelight@0: #define ENGINE_H
truelight@0: 
rubidium@9273: #include "engine_type.h"
peter1138@2848: 
peter1138@8717: void SetupEngines();
rubidium@6573: void StartupEngines();
truelight@0: 
truelight@0: 
peter1138@5919: void DrawTrainEngine(int x, int y, EngineID engine, SpriteID pal);
peter1138@5919: void DrawRoadVehEngine(int x, int y, EngineID engine, SpriteID pal);
peter1138@5919: void DrawShipEngine(int x, int y, EngineID engine, SpriteID pal);
peter1138@5919: void DrawAircraftEngine(int x, int y, EngineID engine, SpriteID pal);
truelight@0: 
rubidium@6573: void LoadCustomEngineNames();
rubidium@6573: void DeleteCustomEngineNames();
truelight@0: 
peter1138@8975: bool IsEngineBuildable(EngineID engine, VehicleType type, PlayerID player);
bjarni@7001: CargoID GetEngineCargoType(EngineID engine);
truelight@0: 
peter1138@8975: static inline EngineID GetFirstEngineOfType(VehicleType type)
bjarni@6195: {
bjarni@6195: 	const EngineID start[] = {0, ROAD_ENGINES_INDEX, SHIP_ENGINES_INDEX, AIRCRAFT_ENGINES_INDEX};
bjarni@6195: 
bjarni@6206: 	return start[type];
bjarni@6195: }
bjarni@6195: 
peter1138@8975: static inline EngineID GetLastEngineOfType(VehicleType type)
bjarni@6195: {
bjarni@6195: 	const EngineID end[] = {
bjarni@6195: 		NUM_TRAIN_ENGINES,
bjarni@6195: 		ROAD_ENGINES_INDEX + NUM_ROAD_ENGINES,
bjarni@6195: 		SHIP_ENGINES_INDEX + NUM_SHIP_ENGINES,
bjarni@6195: 		AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES};
bjarni@6195: 
bjarni@6206: 	return end[type];
bjarni@6195: }
bjarni@6195: 
rubidium@8764: extern Engine _engines[TOTAL_NUM_ENGINES];
Darkvater@1786: #define FOR_ALL_ENGINES(e) for (e = _engines; e != endof(_engines); e++)
bjarni@6195: #define FOR_ALL_ENGINEIDS_OF_TYPE(e, type) for (e = GetFirstEngineOfType(type); e != GetLastEngineOfType(type); e++)
bjarni@6195: 
tron@1926: 
tron@2477: static inline Engine* GetEngine(EngineID i)
Darkvater@1786: {
tron@4077: 	assert(i < lengthof(_engines));
tron@4077: 	return &_engines[i];
Darkvater@1786: }
Darkvater@1786: 
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 */
peter1138@8722: extern const EngineInfo _orig_engine_info[TOTAL_NUM_ENGINES];
peter1138@8722: extern const RailVehicleInfo _orig_rail_vehicle_info[NUM_TRAIN_ENGINES];
peter1138@8722: extern const ShipVehicleInfo _orig_ship_vehicle_info[NUM_SHIP_ENGINES];
peter1138@8722: extern const AircraftVehicleInfo _orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];
peter1138@8722: extern const RoadVehicleInfo _orig_road_vehicle_info[NUM_ROAD_ENGINES];
tron@538: 
tron@2763: extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];
tron@2763: extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];
tron@2763: extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];
tron@2763: extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];
tron@2763: extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];
peter1138@2463: 
peter1138@3393: static inline const EngineInfo *EngInfo(EngineID e)
peter1138@3393: {
peter1138@3393: 	assert(e < lengthof(_engine_info));
peter1138@3393: 	return &_engine_info[e];
peter1138@3393: }
peter1138@3393: 
tron@2477: static inline const RailVehicleInfo* RailVehInfo(EngineID e)
tron@538: {
tron@538: 	assert(e < lengthof(_rail_vehicle_info));
tron@538: 	return &_rail_vehicle_info[e];
tron@538: }
tron@538: 
tron@2477: static inline const ShipVehicleInfo* ShipVehInfo(EngineID e)
tron@538: {
tron@2477: 	assert(e >= SHIP_ENGINES_INDEX && e < SHIP_ENGINES_INDEX + lengthof(_ship_vehicle_info));
tron@538: 	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];
tron@538: }
tron@538: 
tron@2477: static inline const AircraftVehicleInfo* AircraftVehInfo(EngineID e)
tron@538: {
tron@2477: 	assert(e >= AIRCRAFT_ENGINES_INDEX && e < AIRCRAFT_ENGINES_INDEX + lengthof(_aircraft_vehicle_info));
tron@538: 	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];
tron@538: }
tron@538: 
tron@2477: static inline const RoadVehicleInfo* RoadVehInfo(EngineID e)
tron@538: {
tron@2477: 	assert(e >= ROAD_ENGINES_INDEX && e < ROAD_ENGINES_INDEX + lengthof(_road_vehicle_info));
tron@538: 	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];
tron@538: }
darkvater@405: 
KUDr@5187: /* Engine list manipulators - current implementation is only C wrapper of CBlobT<EngineID> class (helpers.cpp) */
KUDr@5187: void EngList_Create(EngineList *el);            ///< Creates engine list
KUDr@5187: void EngList_Destroy(EngineList *el);           ///< Deallocate and destroy engine list
KUDr@5187: uint EngList_Count(const EngineList *el);       ///< Returns number of items in the engine list
KUDr@5187: void EngList_Add(EngineList *el, EngineID eid); ///< Append one item at the end of engine list
KUDr@5187: EngineID* EngList_Items(EngineList *el);        ///< Returns engine list items as C array
KUDr@5187: void EngList_RemoveAll(EngineList *el);         ///< Removes all items from engine list
KUDr@5187: typedef int CDECL EngList_SortTypeFunction(const void*, const void*); ///< argument type for EngList_Sort()
KUDr@5187: void EngList_Sort(EngineList *el, EngList_SortTypeFunction compare); ///< qsort of the engine list
KUDr@5187: void EngList_SortPartial(EngineList *el, EngList_SortTypeFunction compare, uint begin, uint num_items); ///< qsort of specified portion of the engine list
KUDr@5187: 
Darkvater@2436: #endif /* ENGINE_H */