src/engine_base.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file engine_base.h Base class for engines. */
  11
  12 #ifndef ENGINE_BASE_H
  13 #define ENGINE_BASE_H
  14
  15 #include "engine_type.h"
  16 #include "vehicle_type.h"
  17 #include "core/pool_type.hpp"
  18 #include "newgrf_commons.h"
  19
  20 typedef Pool<Engine, EngineID, 64, 64000> EnginePool;
  21 extern EnginePool _engine_pool;
  22
  23 struct Engine : EnginePool::PoolItem<&_engine_pool> {
  24         char *name;                 ///< Custom name of engine.
  25         Date intro_date;            ///< Date of introduction of the engine.
  26         Date age;
  27         uint16 reliability;         ///< Current reliability of the engine.
  28         uint16 reliability_spd_dec; ///< Speed of reliability decay between services (per day).
  29         uint16 reliability_start;   ///< Initial reliability of the engine.
  30         uint16 reliability_max;     ///< Maximal reliability of the engine.
  31         uint16 reliability_final;   ///< Final reliability of the engine.
  32         uint16 duration_phase_1;    ///< First reliability phase in months, increasing reliability from #reliability_start to #reliability_max.
  33         uint16 duration_phase_2;    ///< Second reliability phase in months, keeping #reliability_max.
  34         uint16 duration_phase_3;    ///< Third reliability phase on months, decaying to #reliability_final.
  35         byte flags;                 ///< Flags of the engine. @see EngineFlags
  36         CompanyMask preview_asked;  ///< Bit for each company which has already been offered a preview.
  37         CompanyByte preview_company;///< Company which is currently being offered a preview \c INVALID_COMPANY means no company.
  38         byte preview_wait;          ///< Daily countdown timer for timeout of offering the engine to the #preview_company company.
  39         CompanyMask company_avail;  ///< Bit for each company whether the engine is available for that company.
  40         uint8 original_image_index; ///< Original vehicle image index, thus the image index of the overridden vehicle
  41         VehicleType type;           ///< %Vehicle type, ie #VEH_ROAD, #VEH_TRAIN, etc.
  42
  43         EngineInfo info;
  44
  45         union {
  46                 RailVehicleInfo rail;
  47                 RoadVehicleInfo road;
  48                 ShipVehicleInfo ship;
  49                 AircraftVehicleInfo air;
  50         } u;
  51
  52         /* NewGRF related data */
  53         /**
  54          * Properties related the the grf file.
  55          * NUM_CARGO real cargo plus two pseudo cargo sprite groups.
  56          * Used for obtaining the sprite offset of custom sprites, and for
  57          * evaluating callbacks.
  58          */
  59         GRFFilePropsBase<NUM_CARGO + 2> grf_prop;
  60         uint16 overrides_count;
  61         struct WagonOverride *overrides;
  62         uint16 list_position;
  63
  64         Engine();
  65         Engine(VehicleType type, EngineID base);
  66         ~Engine();
  67         bool IsEnabled() const;
  68
  69         /**
  70          * Determines the default cargo type of an engine.
  71          *
  72          * Usually a valid cargo is returned, even though the vehicle has zero capacity, and can therefore not carry anything. But the cargotype is still used
  73          * for livery selection etc..
  74          *
  75          * Vehicles with CT_INVALID as default cargo are usually not available, but it can appear as default cargo of articulated parts.
  76          *
  77          * @return The default cargo type.
  78          * @see CanCarryCargo
  79          */
  80         CargoID GetDefaultCargoType() const
  81         {
  82                 return this->info.cargo_type;
  83         }
  84
  85         uint DetermineCapacity(const Vehicle *v, uint16 *mail_capacity = NULL) const;
  86
  87         bool CanCarryCargo() const;
  88
  89         /**
  90          * Determines the default cargo capacity of an engine for display purposes.
  91          *
  92          * For planes carrying both passenger and mail this is the passenger capacity.
  93          * For multiheaded engines this is the capacity of both heads.
  94          * For articulated engines use GetCapacityOfArticulatedParts
  95          *
  96          * @param mail_capacity returns secondary cargo (mail) capacity of aircraft
  97          * @return The default capacity
  98          * @see GetDefaultCargoType
  99          */
 100         uint GetDisplayDefaultCapacity(uint16 *mail_capacity = NULL) const
 101         {
 102                 return this->DetermineCapacity(NULL, mail_capacity);
 103         }
 104
 105         Money GetRunningCost() const;
 106         Money GetCost() const;
 107         uint GetDisplayMaxSpeed() const;
 108         uint GetPower() const;
 109         uint GetDisplayWeight() const;
 110         uint GetDisplayMaxTractiveEffort() const;
 111         Date GetLifeLengthInDays() const;
 112         uint16 GetRange() const;
 113
 114         /**
 115          * Check if the engine is a ground vehicle.
 116          * @return True iff the engine is a train or a road vehicle.
 117          */
 118         inline bool IsGroundVehicle() const
 119         {
 120                 return this->type == VEH_TRAIN || this->type == VEH_ROAD;
 121         }
 122
 123         /**
 124          * Retrieve the NewGRF the engine is tied to.
 125          * This is the GRF providing the Action 3.
 126          * @return NewGRF associated to the engine.
 127          */
 128         const GRFFile *GetGRF() const
 129         {
 130                 return this->grf_prop.grffile;
 131         }
 132
 133         uint32 GetGRFID() const;
 134 };
 135
 136 struct EngineIDMapping {
 137         uint32 grfid;          ///< The GRF ID of the file the entity belongs to
 138         uint16 internal_id;    ///< The internal ID within the GRF file
 139         VehicleTypeByte type;  ///< The engine type
 140         uint8  substitute_id;  ///< The (original) entity ID to use if this GRF is not available (currently not used)
 141 };
 142
 143 /**
 144  * Stores the mapping of EngineID to the internal id of newgrfs.
 145  * Note: This is not part of Engine, as the data in the EngineOverrideManager and the engine pool get resetted in different cases.
 146  */
 147 struct EngineOverrideManager : SmallVector<EngineIDMapping, 256> {
 148         static const uint NUM_DEFAULT_ENGINES; ///< Number of default entries
 149
 150         void ResetToDefaultMapping();
 151         EngineID GetID(VehicleType type, uint16 grf_local_id, uint32 grfid);
 152
 153         static bool ResetToCurrentNewGRFConfig();
 154 };
 155
 156 extern EngineOverrideManager _engine_mngr;
 157
 158 #define FOR_ALL_ENGINES_FROM(var, start) FOR_ALL_ITEMS_FROM(Engine, engine_index, var, start)
 159 #define FOR_ALL_ENGINES(var) FOR_ALL_ENGINES_FROM(var, 0)
 160
 161 #define FOR_ALL_ENGINES_OF_TYPE(e, engine_type) FOR_ALL_ENGINES(e) if (e->type == engine_type)
 162
 163 static inline const EngineInfo *EngInfo(EngineID e)
 164 {
 165         return &Engine::Get(e)->info;
 166 }
 167
 168 static inline const RailVehicleInfo *RailVehInfo(EngineID e)
 169 {
 170         return &Engine::Get(e)->u.rail;
 171 }
 172
 173 static inline const RoadVehicleInfo *RoadVehInfo(EngineID e)
 174 {
 175         return &Engine::Get(e)->u.road;
 176 }
 177
 178 static inline const ShipVehicleInfo *ShipVehInfo(EngineID e)
 179 {
 180         return &Engine::Get(e)->u.ship;
 181 }
 182
 183 static inline const AircraftVehicleInfo *AircraftVehInfo(EngineID e)
 184 {
 185         return &Engine::Get(e)->u.air;
 186 }
 187
 188 #endif /* ENGINE_BASE_H */