peter1138@9070: /* $Id$ */
peter1138@9070: 
peter1138@9070: /** @file engine_base.h Base class for engines. */
peter1138@9070: 
peter1138@9070: #ifndef ENGINE_BASE_H
peter1138@9070: #define ENGINE_BASE_H
peter1138@9070: 
peter1138@9070: #include "engine_type.h"
peter1138@9070: #include "oldpool.h"
peter1138@9070: 
peter1138@9070: DECLARE_OLD_POOL(Engine, Engine, 6, 10000)
peter1138@9070: 
peter1138@9070: struct Engine : PoolItem<Engine, EngineID, &_Engine_pool> {
peter1138@9070: 	char *name;         ///< Custom name of engine
peter1138@9070: 	Date intro_date;
peter1138@9070: 	Date age;
peter1138@9070: 	uint16 reliability;
peter1138@9070: 	uint16 reliability_spd_dec;
peter1138@9070: 	uint16 reliability_start, reliability_max, reliability_final;
peter1138@9070: 	uint16 duration_phase_1, duration_phase_2, duration_phase_3;
peter1138@9070: 	byte lifelength;
peter1138@9070: 	byte flags;
rubidium@10207: 	uint8 preview_company_rank;
peter1138@9070: 	byte preview_wait;
rubidium@10207: 	CompanyMask company_avail;
peter1138@9070: 	uint8 image_index; ///< Original vehicle image index
peter1138@9070: 	VehicleType type; ///< type, ie VEH_ROAD, VEH_TRAIN, etc.
peter1138@9070: 
peter1138@9070: 	EngineInfo info;
peter1138@9070: 
peter1138@9070: 	union {
peter1138@9070: 		RailVehicleInfo rail;
peter1138@9070: 		RoadVehicleInfo road;
peter1138@9070: 		ShipVehicleInfo ship;
peter1138@9070: 		AircraftVehicleInfo air;
peter1138@9070: 	} u;
peter1138@9070: 
peter1138@9070: 	/* NewGRF related data */
peter1138@9070: 	const struct GRFFile *grffile;
peter1138@9070: 	const struct SpriteGroup *group[NUM_CARGO + 2];
peter1138@9070: 	uint16 internal_id;                             ///< ID within the GRF file
peter1138@9070: 	uint16 overrides_count;
peter1138@9070: 	struct WagonOverride *overrides;
peter1138@9070: 	uint16 list_position;
peter1138@9070: 
peter1138@9070: 	Engine();
peter1138@9070: 	Engine(VehicleType type, EngineID base);
peter1138@9070: 	~Engine();
peter1138@9070: 
peter1138@9070: 	inline bool IsValid() const { return this->info.climates != 0; }
peter1138@9070: };
peter1138@9070: 
peter1138@9070: static inline bool IsEngineIndex(uint index)
peter1138@9070: {
peter1138@9070: 	return index < GetEnginePoolSize();
peter1138@9070: }
peter1138@9070: 
peter1138@9070: #define FOR_ALL_ENGINES_FROM(e, start) for (e = GetEngine(start); e != NULL; e = (e->index + 1U < GetEnginePoolSize()) ? GetEngine(e->index + 1U) : NULL) if (e->IsValid())
peter1138@9070: #define FOR_ALL_ENGINES(e) FOR_ALL_ENGINES_FROM(e, 0)
peter1138@9070: 
peter1138@9070: #define FOR_ALL_ENGINES_OF_TYPE(e, engine_type) FOR_ALL_ENGINES(e) if (e->type == engine_type)
peter1138@9070: 
peter1138@9070: static inline const EngineInfo *EngInfo(EngineID e)
peter1138@9070: {
peter1138@9070: 	return &GetEngine(e)->info;
peter1138@9070: }
peter1138@9070: 
peter1138@9070: static inline const RailVehicleInfo *RailVehInfo(EngineID e)
peter1138@9070: {
peter1138@9070: 	return &GetEngine(e)->u.rail;
peter1138@9070: }
peter1138@9070: 
peter1138@9070: static inline const RoadVehicleInfo *RoadVehInfo(EngineID e)
peter1138@9070: {
peter1138@9070: 	return &GetEngine(e)->u.road;
peter1138@9070: }
peter1138@9070: 
peter1138@9070: static inline const ShipVehicleInfo *ShipVehInfo(EngineID e)
peter1138@9070: {
peter1138@9070: 	return &GetEngine(e)->u.ship;
peter1138@9070: }
peter1138@9070: 
peter1138@9070: static inline const AircraftVehicleInfo *AircraftVehInfo(EngineID e)
peter1138@9070: {
peter1138@9070: 	return &GetEngine(e)->u.air;
peter1138@9070: }
peter1138@9070: 
peter1138@9070: #endif /* ENGINE_TYPE_H */