OpenTTD
engine_base.h
Go to the documentation of this file.
1 /* $Id: engine_base.h 27797 2017-03-18 20:43:43Z alberth $ */
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 
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 
21 extern EnginePool _engine_pool;
22 
23 struct Engine : EnginePool::PoolItem<&_engine_pool> {
24  char *name;
26  Date age;
27  uint16 reliability;
30  uint16 reliability_max;
35  byte flags;
36  CompanyMask preview_asked;
38  byte preview_wait;
39  CompanyMask company_avail;
40  CompanyMask company_hidden;
43 
44  EngineInfo info;
45 
46  union {
47  RailVehicleInfo rail;
48  RoadVehicleInfo road;
49  ShipVehicleInfo ship;
51  } u;
52 
53  /* NewGRF related data */
61  uint16 overrides_count;
62  struct WagonOverride *overrides;
63  uint16 list_position;
64 
65  Engine();
66  Engine(VehicleType type, EngineID base);
67  ~Engine();
68  bool IsEnabled() const;
69 
82  {
83  return this->info.cargo_type;
84  }
85 
86  uint DetermineCapacity(const Vehicle *v, uint16 *mail_capacity = NULL) const;
87 
88  bool CanCarryCargo() const;
89 
101  uint GetDisplayDefaultCapacity(uint16 *mail_capacity = NULL) const
102  {
103  return this->DetermineCapacity(NULL, mail_capacity);
104  }
105 
106  Money GetRunningCost() const;
107  Money GetCost() const;
108  uint GetDisplayMaxSpeed() const;
109  uint GetPower() const;
110  uint GetDisplayWeight() const;
111  uint GetDisplayMaxTractiveEffort() const;
112  Date GetLifeLengthInDays() const;
113  uint16 GetRange() const;
115 
121  inline bool IsHidden(CompanyByte c) const
122  {
123  return c < MAX_COMPANIES && HasBit(this->company_hidden, c);
124  }
125 
130  inline bool IsGroundVehicle() const
131  {
132  return this->type == VEH_TRAIN || this->type == VEH_ROAD;
133  }
134 
140  const GRFFile *GetGRF() const
141  {
142  return this->grf_prop.grffile;
143  }
144 
145  uint32 GetGRFID() const;
146 };
147 
149  uint32 grfid;
150  uint16 internal_id;
153 };
154 
159 struct EngineOverrideManager : SmallVector<EngineIDMapping, 256> {
160  static const uint NUM_DEFAULT_ENGINES;
161 
162  void ResetToDefaultMapping();
163  EngineID GetID(VehicleType type, uint16 grf_local_id, uint32 grfid);
164 
165  static bool ResetToCurrentNewGRFConfig();
166 };
167 
168 extern EngineOverrideManager _engine_mngr;
169 
170 #define FOR_ALL_ENGINES_FROM(var, start) FOR_ALL_ITEMS_FROM(Engine, engine_index, var, start)
171 #define FOR_ALL_ENGINES(var) FOR_ALL_ENGINES_FROM(var, 0)
172 
173 #define FOR_ALL_ENGINES_OF_TYPE(e, engine_type) FOR_ALL_ENGINES(e) if (e->type == engine_type)
174 
175 static inline const EngineInfo *EngInfo(EngineID e)
176 {
177  return &Engine::Get(e)->info;
178 }
179 
180 static inline const RailVehicleInfo *RailVehInfo(EngineID e)
181 {
182  return &Engine::Get(e)->u.rail;
183 }
184 
185 static inline const RoadVehicleInfo *RoadVehInfo(EngineID e)
186 {
187  return &Engine::Get(e)->u.road;
188 }
189 
190 static inline const ShipVehicleInfo *ShipVehInfo(EngineID e)
191 {
192  return &Engine::Get(e)->u.ship;
193 }
194 
195 static inline const AircraftVehicleInfo *AircraftVehInfo(EngineID e)
196 {
197  return &Engine::Get(e)->u.air;
198 }
199 
200 #endif /* ENGINE_BASE_H */
Information about a ship vehicle.
Definition: engine_type.h:66
uint16 reliability_start
Initial reliability of the engine.
Definition: engine_base.h:29
uint16 reliability
Current reliability of the engine.
Definition: engine_base.h:27
uint GetDisplayDefaultCapacity(uint16 *mail_capacity=NULL) const
Determines the default cargo capacity of an engine for display purposes.
Definition: engine_base.h:101
uint32 grfid
The GRF ID of the file the entity belongs to.
Definition: engine_base.h:149
bool IsEnabled() const
Checks whether the engine is a valid (non-articulated part of an) engine.
Definition: engine.cpp:152
StringID GetAircraftTypeText() const
Get the name of the aircraft type for display purposes.
Definition: engine.cpp:470
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:246
bool CanCarryCargo() const
Determines whether an engine can carry something.
Definition: engine.cpp:173
bool IsHidden(CompanyByte c) const
Check whether the engine is hidden in the GUI for the given company.
Definition: engine_base.h:121
uint16 GetRange() const
Get the range of an aircraft type.
Definition: engine.cpp:456
GRFFilePropsBase< NUM_CARGO+2 > grf_prop
Properties related the the grf file.
Definition: engine_base.h:60
Date intro_date
Date of introduction of the engine.
Definition: engine_base.h:25
Types related to engines.
CompanyMask company_hidden
Bit for each company whether the engine is normally hidden in the build gui for that company...
Definition: engine_base.h:40
Vehicle data structure.
Definition: vehicle_base.h:212
static const uint NUM_DEFAULT_ENGINES
Number of default entries.
Definition: engine_base.h:160
Simple vector template class.
byte flags
Flags of the engine.
Definition: engine_base.h:35
Defintion of Pool, structure used to access PoolItems, and PoolItem, base structure for Vehicle...
CargoID GetDefaultCargoType() const
Determines the default cargo type of an engine.
Definition: engine_base.h:81
uint16 duration_phase_2
Second reliability phase in months, keeping reliability_max.
Definition: engine_base.h:33
uint32 GetGRFID() const
Retrieve the GRF ID of the NewGRF the engine is tied to.
Definition: engine.cpp:162
uint16 reliability_spd_dec
Speed of reliability decay between services (per day).
Definition: engine_base.h:28
Money GetCost() const
Return how much a new engine costs.
Definition: engine.cpp:321
Information about a vehicle.
Definition: engine_type.h:132
uint16 internal_id
The internal ID within the GRF file.
Definition: engine_base.h:150
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
uint16 duration_phase_3
Third reliability phase on months, decaying to reliability_final.
Definition: engine_base.h:34
Stores the mapping of EngineID to the internal id of newgrfs.
Definition: engine_base.h:159
uint16 duration_phase_1
First reliability phase in months, increasing reliability from reliability_start to reliability_max...
Definition: engine_base.h:32
VehicleType type
Vehicle type, ie VEH_ROAD, VEH_TRAIN, etc.
Definition: engine_base.h:42
CompanyMask company_avail
Bit for each company whether the engine is available for that company.
Definition: engine_base.h:39
uint16 reliability_max
Maximal reliability of the engine.
Definition: engine_base.h:30
Road vehicle type.
Definition: vehicle_type.h:25
uint16 reliability_final
Final reliability of the engine.
Definition: engine_base.h:31
char * name
Custom name of engine.
Definition: engine_base.h:24
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
Base class for all PoolItems.
Definition: pool_type.hpp:146
Maximum number of companies.
Definition: company_type.h:25
Information about a rail vehicle.
Definition: engine_type.h:43
uint GetDisplayMaxSpeed() const
Returns max speed of the engine for display purposes.
Definition: engine.cpp:361
Base class for all pools.
Definition: pool_type.hpp:83
uint DetermineCapacity(const Vehicle *v, uint16 *mail_capacity=NULL) const
Determines capacity of a given vehicle from scratch.
Definition: engine.cpp:206
uint GetPower() const
Returns the power of the engine for display and sorting purposes.
Definition: engine.cpp:393
byte preview_wait
Daily countdown timer for timeout of offering the engine to the preview_company company.
Definition: engine_base.h:38
Information about a road vehicle.
Definition: engine_type.h:112
const GRFFile * GetGRF() const
Retrieve the NewGRF the engine is tied to.
Definition: engine_base.h:140
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:22
Information about a aircraft vehicle.
Definition: engine_type.h:98
CompanyMask preview_asked
Bit for each company which has already been offered a preview.
Definition: engine_base.h:36
VehicleTypeByte type
The engine type.
Definition: engine_base.h:151
Types related to vehicles.
uint8 substitute_id
The (original) entity ID to use if this GRF is not available (currently not used) ...
Definition: engine_base.h:152
This file simplyfies and embeds a common mechanism of loading/saving and mapping of grf entities...
CompanyByte preview_company
Company which is currently being offered a preview INVALID_COMPANY means no company.
Definition: engine_base.h:37
int32 Date
The type to store our dates in.
Definition: date_type.h:16
uint8 original_image_index
Original vehicle image index, thus the image index of the overridden vehicle.
Definition: engine_base.h:41
bool IsGroundVehicle() const
Check if the engine is a ground vehicle.
Definition: engine_base.h:130
Money GetRunningCost() const
Return how much the running costs of this engine are.
Definition: engine.cpp:284
const struct GRFFile * grffile
grf file that introduced this entity
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
uint GetDisplayWeight() const
Returns the weight of the engine for display purposes.
Definition: engine.cpp:411
uint GetDisplayMaxTractiveEffort() const
Returns the tractive effort of the engine for display purposes.
Definition: engine.cpp:429
Date GetLifeLengthInDays() const
Returns the vehicle&#39;s (not model&#39;s!) life length in days.
Definition: engine.cpp:446
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:104
Train vehicle type.
Definition: vehicle_type.h:24