tron@2186: /* $Id$ */
tron@2186: 
belugas@6451: /** @file engine.h */
belugas@6451: 
truelight@0: #ifndef ENGINE_H
truelight@0: #define ENGINE_H
truelight@0: 
matthijs@5216: #include "oldpool.h"
rubidium@5838: #include "rail.h"
rubidium@5838: #include "sound.h"
bjarni@6195: #include "vehicle.h"
darkvater@405: 
belugas@6119: enum RailVehicleTypes {
belugas@6451: 	RAILVEH_SINGLEHEAD,  ///< indicates a "standalone" locomotive
belugas@6451: 	RAILVEH_MULTIHEAD,   ///< indicates a combination of two locomotives
belugas@6451: 	RAILVEH_WAGON,       ///< simple wagon, not motorized
belugas@6119: };
belugas@6119: 
rubidium@7077: enum EngineClass {
rubidium@7077: 	EC_STEAM,
rubidium@7077: 	EC_DIESEL,
rubidium@7077: 	EC_ELECTRIC,
rubidium@7081: 	EC_MONORAIL,
rubidium@7081: 	EC_MAGLEV,
rubidium@7077: };
rubidium@7077: 
rubidium@6574: struct RailVehicleInfo {
truelight@0: 	byte image_index;
belugas@6119: 	RailVehicleTypes railveh_type;
truelight@0: 	byte base_cost;
tron@6074: 	RailTypeByte railtype;
truelight@0: 	uint16 max_speed;
truelight@0: 	uint16 power;
peter1138@2542: 	uint16 weight;
truelight@0: 	byte running_cost_base;
peter1138@2840: 	byte running_cost_class;
rubidium@7077: 	EngineClass engclass;           ///< Class of engine for this vehicle
truelight@0: 	byte capacity;
Darkvater@3344: 	CargoID cargo_type;
peter1138@3022: 	byte ai_rank;
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.
belugas@6451: 	byte shorten_factor;   ///< length on main map for this type is 8 - shorten_factor
peter1138@5588: 	byte tractive_effort; ///< Tractive effort coefficient
belugas@6451: 	byte user_def_data;    ///< Property 0x25: "User-defined bit mask" Used only for (very few) NewGRF vehicles
rubidium@6574: };
truelight@0: 
rubidium@6574: struct ShipVehicleInfo {
truelight@0: 	byte image_index;
truelight@0: 	byte base_cost;
truelight@0: 	uint16 max_speed;
Darkvater@3344: 	CargoID cargo_type;
truelight@0: 	uint16 capacity;
truelight@0: 	byte running_cost;
rubidium@5838: 	SoundFxByte sfx;
rubidium@5838: 	bool refittable;
rubidium@6574: };
truelight@0: 
Darkvater@6106: /* AircraftVehicleInfo subtypes, bitmask type.
Darkvater@6106:  * If bit 0 is 0 then it is a helicopter, otherwise it is a plane
Darkvater@6106:  * in which case bit 1 tells us whether it's a big(fast) plane or not */
tron@4023: enum {
Darkvater@6106: 	AIR_HELI = 0,
belugas@6451: 	AIR_CTOL = 1, ///< Conventional Take Off and Landing, i.e. planes
tron@4023: 	AIR_FAST = 2
tron@4023: };
tron@4023: 
rubidium@6574: struct AircraftVehicleInfo {
darkvater@376: 	byte image_index;
darkvater@376: 	byte base_cost;
darkvater@376: 	byte running_cost;
darkvater@376: 	byte subtype;
rubidium@5838: 	SoundFxByte sfx;
darkvater@376: 	byte acceleration;
celestar@6519: 	uint16 max_speed;
darkvater@376: 	byte mail_capacity;
celestar@922: 	uint16 passenger_capacity;
rubidium@6574: };
darkvater@376: 
rubidium@6574: struct RoadVehicleInfo {
darkvater@376: 	byte image_index;
darkvater@376: 	byte base_cost;
darkvater@376: 	byte running_cost;
rubidium@5838: 	SoundFxByte sfx;
darkvater@376: 	byte max_speed;
darkvater@376: 	byte capacity;
Darkvater@3344: 	CargoID cargo_type;
rubidium@6574: };
truelight@0: 
celestar@2129: /** Information about a vehicle
rubidium@4549:  *  @see table/engines.h
rubidium@4549:  */
rubidium@6574: struct EngineInfo {
rubidium@4289: 	Date base_intro;
rubidium@4326: 	Year lifelength;
rubidium@4326: 	Year base_life;
belugas@6984: 	byte unk2;         ///< flag for carriage(bit 7) and decay speed(bits0..6)
peter1138@5211: 	byte load_amount;
tron@6014: 	byte climates;
peter1138@2611: 	uint32 refit_mask;
peter1138@3997: 	byte refit_cost;
peter1138@3095: 	byte misc_flags;
peter1138@3956: 	byte callbackmask;
peter1138@7102: 	byte retire_early; ///< Number of years early to retire vehicle
rubidium@6574: };
truelight@0: 
rubidium@6574: struct Engine {
rubidium@4289: 	Date intro_date;
rubidium@4289: 	Date 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;
rubidium@5838: 	PlayerByte preview_player;
truelight@0: 	byte preview_wait;
truelight@2331: 	byte player_avail;
rubidium@7134: 	VehicleType type; ///< type, ie VEH_ROAD, VEH_TRAIN, etc. Same as in vehicle.h
rubidium@6574: };
truelight@0: 
peter1138@3113: /**
peter1138@3113:  * EngineInfo.misc_flags is a bitmask, with the following values
peter1138@3113:  */
peter1138@3113: enum {
peter1138@3113: 	EF_RAIL_TILTS = 0, ///< Rail vehicle tilts in curves (unsupported)
peter1138@3113: 	EF_ROAD_TRAM  = 0, ///< Road vehicle is a tram/light rail vehicle (unsup)
peter1138@3113: 	EF_USES_2CC   = 1, ///< Vehicle uses two company colours
peter1138@3113: 	EF_RAIL_IS_MU = 2, ///< Rail vehicle is a multiple-unit (DMU/EMU)
peter1138@3113: };
truelight@0: 
maedhros@6500: /**
maedhros@6500:  * Engine.flags is a bitmask, with the following values.
maedhros@6500:  */
maedhros@6500: enum {
maedhros@6500: 	ENGINE_AVAILABLE         = 1, ///< This vehicle is available to everyone.
maedhros@6500: 	ENGINE_EXCLUSIVE_PREVIEW = 2, ///< This vehicle is in the exclusive preview stage, either being used or being offered to a player.
maedhros@6500: 	ENGINE_OFFER_WINDOW_OPEN = 4, ///< The exclusive offer window is currently open for a player.
maedhros@6500: };
maedhros@6500: 
truelight@0: enum {
Darkvater@1802: 	NUM_VEHICLE_TYPES = 6
Darkvater@1802: };
truelight@0: 
rubidium@5838: static const EngineID INVALID_ENGINE = 0xFFFF;
rubidium@5838: 
peter1138@2848: 
rubidium@6573: void AddTypeToEngines();
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@5215: bool IsEngineBuildable(EngineID engine, byte type, PlayerID player);
bjarni@7001: CargoID GetEngineCargoType(EngineID engine);
truelight@0: 
truelight@0: enum {
truelight@0: 	NUM_NORMAL_RAIL_ENGINES = 54,
rubidium@4344: 	NUM_MONORAIL_ENGINES    = 30,
rubidium@4344: 	NUM_MAGLEV_ENGINES      = 32,
rubidium@4344: 	NUM_TRAIN_ENGINES       = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,
rubidium@4344: 	NUM_ROAD_ENGINES        = 88,
rubidium@4344: 	NUM_SHIP_ENGINES        = 11,
rubidium@4344: 	NUM_AIRCRAFT_ENGINES    = 41,
rubidium@4344: 	TOTAL_NUM_ENGINES       = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,
rubidium@4344: 	AIRCRAFT_ENGINES_INDEX  = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,
rubidium@4344: 	SHIP_ENGINES_INDEX      = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,
rubidium@4344: 	ROAD_ENGINES_INDEX      = NUM_TRAIN_ENGINES,
truelight@0: };
bjarni@6195: 
bjarni@6195: static inline EngineID GetFirstEngineOfType(byte 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: 
bjarni@6195: static inline EngineID GetLastEngineOfType(byte 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: 
truelight@0: VARDEF 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: 
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"
peter1138@2463: extern const EngineInfo orig_engine_info[TOTAL_NUM_ENGINES];
peter1138@2463: extern const RailVehicleInfo orig_rail_vehicle_info[NUM_TRAIN_ENGINES];
peter1138@2463: extern const ShipVehicleInfo orig_ship_vehicle_info[NUM_SHIP_ENGINES];
peter1138@2463: extern const AircraftVehicleInfo orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];
peter1138@2463: 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: 
peter1138@2848: /************************************************************************
peter1138@2848:  * Engine Replacement stuff
peter1138@2848:  ************************************************************************/
peter1138@2848: 
peter1138@2848: /**
peter1138@2848:  * Struct to store engine replacements. DO NOT USE outside of engine.c. Is
peter1138@2848:  * placed here so the only exception to this rule, the saveload code, can use
peter1138@2848:  * it.
peter1138@2848:  */
peter1138@2848: struct EngineRenew {
truelight@4348: 	EngineRenewID index;
peter1138@2848: 	EngineID from;
peter1138@2848: 	EngineID to;
rubidium@6574: 	EngineRenew *next;
peter1138@2848: };
peter1138@2848: 
peter1138@2848: /**
peter1138@2848:  * Memory pool for engine renew elements. DO NOT USE outside of engine.c. Is
peter1138@2848:  * placed here so the only exception to this rule, the saveload code, can use
peter1138@2848:  * it.
peter1138@2848:  */
matthijs@5216: DECLARE_OLD_POOL(EngineRenew, EngineRenew, 3, 8000)
truelight@4348: 
truelight@4348: /**
truelight@4348:  * Check if a EngineRenew really exists.
truelight@4348:  */
truelight@4348: static inline bool IsValidEngineRenew(const EngineRenew *er)
truelight@4348: {
truelight@4348: 	return er->from != INVALID_ENGINE;
truelight@4348: }
truelight@4348: 
truelight@4384: static inline void DeleteEngineRenew(EngineRenew *er)
truelight@4384: {
truelight@4384: 	er->from = INVALID_ENGINE;
truelight@4384: }
truelight@4384: 
tron@4974: #define FOR_ALL_ENGINE_RENEWS_FROM(er, start) for (er = GetEngineRenew(start); er != NULL; er = (er->index + 1U < GetEngineRenewPoolSize()) ? GetEngineRenew(er->index + 1U) : NULL) if (er->from != INVALID_ENGINE) if (IsValidEngineRenew(er))
truelight@4348: #define FOR_ALL_ENGINE_RENEWS(er) FOR_ALL_ENGINE_RENEWS_FROM(er, 0)
truelight@4348: 
peter1138@2848: 
peter1138@2848: /**
peter1138@2848:  * A list to group EngineRenew directives together (such as per-player).
peter1138@2848:  */
peter1138@2848: typedef EngineRenew* EngineRenewList;
peter1138@2848: 
peter1138@2848: /**
peter1138@2848:  * Remove all engine replacement settings for the player.
belugas@6977:  * @param  erl The renewlist for a given player.
peter1138@2848:  * @return The new renewlist for the player.
peter1138@2848:  */
peter1138@2848: void RemoveAllEngineReplacement(EngineRenewList* erl);
peter1138@2848: 
peter1138@2848: /**
peter1138@2848:  * Retrieve the engine replacement in a given renewlist for an original engine type.
peter1138@2848:  * @param  erl The renewlist to search in.
peter1138@2848:  * @param  engine Engine type to be replaced.
peter1138@2848:  * @return The engine type to replace with, or INVALID_ENGINE if no
peter1138@2848:  * replacement is in the list.
peter1138@2848:  */
peter1138@2848: EngineID EngineReplacement(EngineRenewList erl, EngineID engine);
peter1138@2848: 
peter1138@2848: /**
peter1138@2848:  * Add an engine replacement to the given renewlist.
peter1138@2848:  * @param erl The renewlist to add to.
peter1138@2848:  * @param old_engine The original engine type.
peter1138@2848:  * @param new_engine The replacement engine type.
peter1138@2848:  * @param flags The calling command flags.
peter1138@2848:  * @return 0 on success, CMD_ERROR on failure.
peter1138@2848:  */
peter1138@2848: int32 AddEngineReplacement(EngineRenewList* erl, EngineID old_engine, EngineID new_engine, uint32 flags);
peter1138@2848: 
peter1138@2848: /**
peter1138@2848:  * Remove an engine replacement from a given renewlist.
peter1138@2848:  * @param erl The renewlist from which to remove the replacement
peter1138@2848:  * @param engine The original engine type.
peter1138@2848:  * @param flags The calling command flags.
peter1138@2848:  * @return 0 on success, CMD_ERROR on failure.
peter1138@2848:  */
peter1138@2848: int32 RemoveEngineReplacement(EngineRenewList* erl, EngineID engine, uint32 flags);
peter1138@2848: 
bjarni@6195: /** When an engine is made buildable or is removed from being buildable, add/remove it from the build/autoreplace lists
bjarni@6195:  * @param type The type of engine
bjarni@6195:  */
rubidium@7134: void AddRemoveEngineFromAutoreplaceAndBuildWindows(VehicleType type);
bjarni@6195: 
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 */