OpenTTD
aircraft.h
Go to the documentation of this file.
1 /* $Id: aircraft.h 26866 2014-09-21 06:35:34Z rubidium $ */
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 AIRCRAFT_H
13 #define AIRCRAFT_H
14 
15 #include "station_map.h"
16 #include "vehicle_base.h"
17 
27 };
28 
29 struct Aircraft;
30 
35  AIR_SHADOW = 4,
36  AIR_ROTOR = 6,
37 };
38 
42 
43  /* The next two flags are to prevent stair climbing of the aircraft. The idea is that the aircraft
44  * will ascend or descend multiple flight levels at a time instead of following the contours of the
45  * landscape at a fixed altitude. This only has effect when there are more than 15 height levels. */
48 };
49 
50 static const int ROTOR_Z_OFFSET = 5;
51 
53 void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type);
54 void UpdateAirplanesOnNewStation(const Station *st);
55 void UpdateAircraftCache(Aircraft *v, bool update_range = false);
56 
57 void AircraftLeaveHangar(Aircraft *v, Direction exit_dir);
59 void SetAircraftPosition(Aircraft *v, int x, int y, int z);
60 
61 void GetAircraftFlightLevelBounds(const Vehicle *v, int *min, int *max);
62 template <class T>
63 int GetAircraftFlightLevel(T *v, bool takeoff = false);
64 
66 struct AircraftCache {
69 };
70 
74 struct Aircraft FINAL : public SpecializedVehicle<Aircraft, VEH_AIRCRAFT> {
75  uint16 crashed_counter;
76  byte pos;
77  byte previous_pos;
78  StationID targetairport;
79  byte state;
80  DirectionByte last_direction;
82  byte turn_counter;
83  byte flags;
84 
85  AircraftCache acache;
86 
90  virtual ~Aircraft() { this->PreDestructor(); }
91 
92  void MarkDirty();
94  ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_AIRCRAFT_INC : EXPENSES_AIRCRAFT_RUN; }
95  bool IsPrimaryVehicle() const { return this->IsNormalAircraft(); }
97  int GetDisplaySpeed() const { return this->cur_speed; }
98  int GetDisplayMaxSpeed() const { return this->vcache.cached_max_speed; }
99  int GetSpeedOldUnits() const { return this->vcache.cached_max_speed * 10 / 128; }
100  int GetCurrentMaxSpeed() const { return this->GetSpeedOldUnits(); }
101  Money GetRunningCost() const;
102 
103  bool IsInDepot() const
104  {
105  assert(this->IsPrimaryVehicle());
106  return (this->vehstatus & VS_HIDDEN) != 0 && IsHangarTile(this->tile);
107  }
108 
109  bool Tick();
110  void OnNewDay();
111  uint Crash(bool flooded = false);
112  TileIndex GetOrderStationLocation(StationID station);
113  bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse);
114 
121  inline bool IsNormalAircraft() const
122  {
123  /* To be fully correct the commented out functionality is the proper one,
124  * but since value can only be 0 or 2, it is sufficient to only check <= 2
125  * return (this->subtype == AIR_HELICOPTER) || (this->subtype == AIR_AIRCRAFT); */
126  return this->subtype <= AIR_AIRCRAFT;
127  }
128 
133  uint16 GetRange() const
134  {
135  return this->acache.cached_max_range;
136  }
137 };
138 
142 #define FOR_ALL_AIRCRAFT(var) FOR_ALL_VEHICLES_OF_TYPE(Aircraft, var)
143 
144 SpriteID GetRotorImage(const Aircraft *v, EngineImageType image_type);
145 
147 
148 #endif /* AIRCRAFT_H */