OpenTTD Source: src/aircraft.h Source File

OpenTTD Source 13.1

aircraft.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10 #ifndef AIRCRAFT_H
11 #define AIRCRAFT_H
12
13 #include "station_map.h"
14 #include "vehicle_base.h"
15
20 enum AircraftFlyingAltitude {
21 AIRCRAFT_MIN_FLYING_ALTITUDE = 120,
22 AIRCRAFT_MAX_FLYING_ALTITUDE = 360,
23 PLANE_HOLD_MAX_FLYING_ALTITUDE = 150,
24 HELICOPTER_HOLD_MAX_FLYING_ALTITUDE = 184
25 };
26
27 struct Aircraft;
28
30 enum AircraftSubType {
31 AIR_HELICOPTER = 0,
32 AIR_AIRCRAFT = 2,
33 AIR_SHADOW = 4,
34 AIR_ROTOR = 6,
35 };
36
38 enum AirVehicleFlags {
39 VAF_DEST_TOO_FAR = 0,
40
41 /* The next two flags are to prevent stair climbing of the aircraft. The idea is that the aircraft
42 * will ascend or descend multiple flight levels at a time instead of following the contours of the
43 * landscape at a fixed altitude. This only has effect when there are more than 15 height levels. */
44 VAF_IN_MAX_HEIGHT_CORRECTION = 1,
45 VAF_IN_MIN_HEIGHT_CORRECTION = 2,
46
47 VAF_HELI_DIRECT_DESCENT = 3,
48 };
49
50 static const int ROTOR_Z_OFFSET = 5;
51
52 void HandleAircraftEnterHangar(Aircraft *v);
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);
58 void AircraftNextAirportPos_and_Order(Aircraft *v);
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 {
67 uint32 cached_max_range_sqr;
68 uint16 cached_max_range;
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 Direction last_direction;
81 byte number_consecutive_turns;
82 byte turn_counter;
83 byte flags;
84
85 AircraftCache acache;
86
88 Aircraft() : SpecializedVehicleBase() {}
90 virtual ~Aircraft() { this->PreDestructor(); }
91
92 void MarkDirty();
93 void UpdateDeltaXY();
94 ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_AIRCRAFT_REVENUE : EXPENSES_AIRCRAFT_RUN; }
95 bool IsPrimaryVehicle() const { return this->IsNormalAircraft(); }
96 void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const;
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
139 void GetRotorImage(const Aircraft *v, EngineImageType image_type, VehicleSpriteSeq *result);
140
141 Station *GetTargetAirportIfValid(const Aircraft *v);
142
143 #endif /* AIRCRAFT_H */
Aircraft::targetairport
StationID targetairport
Airport to go to next.
Definition: aircraft.h:78
Aircraft::Aircraft
Aircraft()
We don't want GCC to zero our struct! It already is zeroed and has an index!
Definition: aircraft.h:88
AircraftNextAirportPos_and_Order
void AircraftNextAirportPos_and_Order(Aircraft *v)
set the right pos when heading to other airports after takeoff
Definition: aircraft_cmd.cpp:1435
Vehicle::PreDestructor
void PreDestructor()
Destroy all stuff that (still) needs the virtual functions to work properly.
Definition: vehicle.cpp:814
Direction
Direction
Defines the 8 directions on the map.
Definition: direction_type.h:24
AircraftSubType
AircraftSubType
An aircraft can be one of those types.
Definition: aircraft.h:30
Aircraft::~Aircraft
virtual ~Aircraft()
We want to 'destruct' the right class.
Definition: aircraft.h:90
UpdateAirplanesOnNewStation
void UpdateAirplanesOnNewStation(const Station *st)
Updates the status of the Aircraft heading or in the station.
Definition: aircraft_cmd.cpp:2143
Station
Station data structure.
Definition: station_base.h:454
PLANE_HOLD_MAX_FLYING_ALTITUDE
@ PLANE_HOLD_MAX_FLYING_ALTITUDE
holding flying altitude above tile of planes.
Definition: aircraft.h:23
Vehicle::vehstatus
byte vehstatus
Status.
Definition: vehicle_base.h:332
TileIndex
The index/ID of a Tile.
Definition: tile_type.h:85
VAF_IN_MAX_HEIGHT_CORRECTION
@ VAF_IN_MAX_HEIGHT_CORRECTION
The vehicle is currently lowering its altitude because it hit the upper bound.
Definition: aircraft.h:44
vehicle_base.h
EXPENSES_AIRCRAFT_RUN
@ EXPENSES_AIRCRAFT_RUN
Running costs aircraft.
Definition: economy_type.h:162
Aircraft::number_consecutive_turns
byte number_consecutive_turns
Protection to prevent the aircraft of making a lot of turns in order to reach a specific point.
Definition: aircraft.h:81
AircraftLeaveHangar
void AircraftLeaveHangar(Aircraft *v, Direction exit_dir)
Aircraft is about to leave the hangar.
Definition: aircraft_cmd.cpp:1455
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:86
Vehicle::cur_speed
uint16 cur_speed
current speed
Definition: vehicle_base.h:307
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:224
AIR_AIRCRAFT
@ AIR_AIRCRAFT
an airplane
Definition: aircraft.h:32
Aircraft::FindClosestDepot
bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse)
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should...
Definition: aircraft_cmd.cpp:391
Aircraft::GetRange
uint16 GetRange() const
Get the range of this aircraft.
Definition: aircraft.h:133
GetTargetAirportIfValid
Station * GetTargetAirportIfValid(const Aircraft *v)
Returns aircraft's target station if v->target_airport is a valid station with airport.
Definition: aircraft_cmd.cpp:2129
AIR_SHADOW
@ AIR_SHADOW
shadow of the aircraft
Definition: aircraft.h:33
AircraftCache
Variables that are cached to improve performance and such.
Definition: aircraft.h:66
HandleAircraftEnterHangar
void HandleAircraftEnterHangar(Aircraft *v)
Handle Aircraft specific tasks when an Aircraft enters a hangar.
Definition: aircraft_cmd.cpp:560
Aircraft
Aircraft, helicopters, rotors and their shadows belong to this class.
Definition: aircraft.h:74
VS_HIDDEN
@ VS_HIDDEN
Vehicle is not visible.
Definition: vehicle_base.h:34
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
AIRCRAFT_MAX_FLYING_ALTITUDE
@ AIRCRAFT_MAX_FLYING_ALTITUDE
Maximum flying altitude above tile.
Definition: aircraft.h:22
Aircraft::GetRunningCost
Money GetRunningCost() const
Gets the running cost of a vehicle.
Definition: aircraft_cmd.cpp:436
VAF_HELI_DIRECT_DESCENT
@ VAF_HELI_DIRECT_DESCENT
The helicopter is descending directly at its destination (helipad or in front of hangar)
Definition: aircraft.h:47
Aircraft::turn_counter
byte turn_counter
Ticks between each turn to prevent > 45 degree turns.
Definition: aircraft.h:82
Vehicle::tile
TileIndex tile
Current tile index.
Definition: vehicle_base.h:245
Aircraft::IsPrimaryVehicle
bool IsPrimaryVehicle() const
Whether this is the primary vehicle in the chain.
Definition: aircraft.h:95
Aircraft::GetDisplaySpeed
int GetDisplaySpeed() const
Gets the speed in km-ish/h that can be sent into SetDParam for string processing.
Definition: aircraft.h:97
VehicleSpriteSeq
Sprite sequence for a vehicle part.
Definition: vehicle_base.h:132
SpecializedVehicle
Class defining several overloaded accessors so we don't have to cast vehicle types that often.
Definition: vehicle_base.h:1063
GetAircraftFlightLevelBounds
void GetAircraftFlightLevelBounds(const Vehicle *v, int *min, int *max)
Get the 'flight level' bounds, in pixels from 'z_pos' 0 for a particular vehicle for normal flight si...
Definition: aircraft_cmd.cpp:717
SetAircraftPosition
void SetAircraftPosition(Aircraft *v, int x, int y, int z)
Set aircraft position.
Definition: aircraft_cmd.cpp:521
Aircraft::Crash
uint Crash(bool flooded=false)
Crash the (whole) vehicle chain.
Definition: aircraft_cmd.cpp:1307
AirVehicleFlags
AirVehicleFlags
Flags for air vehicles; shared with disaster vehicles.
Definition: aircraft.h:38
VAF_IN_MIN_HEIGHT_CORRECTION
@ VAF_IN_MIN_HEIGHT_CORRECTION
The vehicle is currently raising its altitude because it hit the lower bound.
Definition: aircraft.h:45
Aircraft::GetCurrentMaxSpeed
int GetCurrentMaxSpeed() const
Calculates the maximum speed of the vehicle under its current conditions.
Definition: aircraft.h:100
Aircraft::GetDisplayMaxSpeed
int GetDisplayMaxSpeed() const
Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing.
Definition: aircraft.h:98
Aircraft::GetImage
void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
Gets the sprite to show for the given direction.
Definition: aircraft_cmd.cpp:172
Aircraft::GetExpenseType
ExpensesType GetExpenseType(bool income) const
Sets the expense type associated to this vehicle type.
Definition: aircraft.h:94
Vehicle::direction
Direction direction
facing
Definition: vehicle_base.h:286
UpdateAircraftCache
void UpdateAircraftCache(Aircraft *v, bool update_range=false)
Update cached values of an aircraft.
Definition: aircraft_cmd.cpp:590
Aircraft::GetOrderStationLocation
TileIndex GetOrderStationLocation(StationID station)
Determine the location for the station where the vehicle goes to next.
Definition: aircraft_cmd.cpp:1286
VAF_DEST_TOO_FAR
@ VAF_DEST_TOO_FAR
Next destination is too far away.
Definition: aircraft.h:39
Vehicle::vcache
VehicleCache vcache
Cache of often used vehicle values.
Definition: vehicle_base.h:345
AircraftCache::cached_max_range_sqr
uint32 cached_max_range_sqr
Cached squared maximum range.
Definition: aircraft.h:67
GetAircraftSpriteSize
void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of an aircraft sprite heading west (used for lists).
Definition: aircraft_cmd.cpp:247
HELICOPTER_HOLD_MAX_FLYING_ALTITUDE
@ HELICOPTER_HOLD_MAX_FLYING_ALTITUDE
holding flying altitude above tile of helicopters.
Definition: aircraft.h:24
Aircraft::crashed_counter
uint16 crashed_counter
Timer for handling crash animations.
Definition: aircraft.h:75
Aircraft::OnNewDay
void OnNewDay()
Calls the new day handler of the vehicle.
Definition: aircraft_cmd.cpp:443
AIR_HELICOPTER
@ AIR_HELICOPTER
an helicopter
Definition: aircraft.h:31
Aircraft::IsNormalAircraft
bool IsNormalAircraft() const
Check if the aircraft type is a normal flying device; eg not a rotor or a shadow.
Definition: aircraft.h:121
Aircraft::previous_pos
byte previous_pos
Previous desired position of the aircraft.
Definition: aircraft.h:77
VehicleCache::cached_max_speed
uint16 cached_max_speed
Maximum speed of the consist (minimum of the max speed of all vehicles in the consist).
Definition: vehicle_base.h:125
Aircraft::IsInDepot
bool IsInDepot() const
Check whether the vehicle is in the depot.
Definition: aircraft.h:103
Aircraft::pos
byte pos
Next desired position of the aircraft.
Definition: aircraft.h:76
Vehicle::subtype
byte subtype
subtype (Filled with values from AircraftSubType/DisasterSubType/EffectVehicleType/GroundVehicleSubty...
Definition: vehicle_base.h:342
station_map.h
OverflowSafeInt< int64 >
AircraftFlyingAltitude
AircraftFlyingAltitude
Base values for flight levels above ground level for 'normal' flight and holding patterns.
Definition: aircraft.h:20
AircraftCache::cached_max_range
uint16 cached_max_range
Cached maximum range.
Definition: aircraft.h:68
Aircraft::state
byte state
State of the airport.
Definition: aircraft.h:79
ExpensesType
ExpensesType
Types of expenses.
Definition: economy_type.h:157
Aircraft::Tick
bool Tick()
Calls the tick handler of the vehicle.
Definition: aircraft_cmd.cpp:2100
Aircraft::UpdateDeltaXY
void UpdateDeltaXY()
Updates the x and y offsets and the size of the sprite used for this vehicle.
Definition: aircraft_cmd.cpp:47
Aircraft::MarkDirty
void MarkDirty()
Marks the vehicles to be redrawn and updates cached variables.
Definition: aircraft_cmd.cpp:1297
Aircraft::flags
byte flags
Aircraft flags.
Definition: aircraft.h:83
EXPENSES_AIRCRAFT_REVENUE
@ EXPENSES_AIRCRAFT_REVENUE
Revenue from aircraft.
Definition: economy_type.h:167
AIRCRAFT_MIN_FLYING_ALTITUDE
@ AIRCRAFT_MIN_FLYING_ALTITUDE
Minimum flying altitude above tile.
Definition: aircraft.h:21
IsHangarTile
static bool IsHangarTile(TileIndex t)
Is tile t an hangar tile?
Definition: station_map.h:326
AIR_ROTOR
@ AIR_ROTOR
rotor of an helicopter
Definition: aircraft.h:34
ROTOR_Z_OFFSET
static const int ROTOR_Z_OFFSET
Z Offset between helicopter- and rotorsprite.
Definition: aircraft.h:50