OpenTTD
airport.h
Go to the documentation of this file.
1 /* $Id: airport.h 25841 2013-10-12 16:34:59Z frosch $ */
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 AIRPORT_H
13 #define AIRPORT_H
14 
15 #include "direction_type.h"
16 #include "tile_type.h"
17 
19 static const uint MAX_TERMINALS = 8;
20 static const uint MAX_HELIPADS = 3;
21 static const uint MAX_ELEMENTS = 255;
22 
23 static const uint NUM_AIRPORTTILES_PER_GRF = 255;
24 
25 static const uint NUM_AIRPORTTILES = 256;
26 static const uint NEW_AIRPORTTILE_OFFSET = 74;
28 
31  AT_SMALL = 0,
32  AT_LARGE = 1,
40  AT_OILRIG = 9,
43  NUM_AIRPORTS = 128,
44  AT_INVALID = 254,
45  AT_DUMMY = 255,
46 };
47 
50  AMED_NOSPDCLAMP = 1 << 0,
51  AMED_TAKEOFF = 1 << 1,
52  AMED_SLOWTURN = 1 << 2,
53  AMED_LAND = 1 << 3,
54  AMED_EXACTPOS = 1 << 4,
55  AMED_BRAKE = 1 << 5,
56  AMED_HELI_RAISE = 1 << 6,
57  AMED_HELI_LOWER = 1 << 7,
58  AMED_HOLD = 1 << 8,
59 };
60 
63  TO_ALL = 0,
64  HANGAR = 1,
65  TERM1 = 2,
66  TERM2 = 3,
67  TERM3 = 4,
68  TERM4 = 5,
69  TERM5 = 6,
70  TERM6 = 7,
71  HELIPAD1 = 8,
72  HELIPAD2 = 9,
73  TAKEOFF = 10,
74  STARTTAKEOFF = 11,
75  ENDTAKEOFF = 12,
76  HELITAKEOFF = 13,
77  FLYING = 14,
78  LANDING = 15,
79  ENDLANDING = 16,
80  HELILANDING = 17,
82  TERM7 = 19,
83  TERM8 = 20,
84  HELIPAD3 = 21,
85  MAX_HEADINGS = 21,
86 };
87 
89 static const uint64
90  TERM1_block = 1ULL << 0,
91  TERM2_block = 1ULL << 1,
92  TERM3_block = 1ULL << 2,
93  TERM4_block = 1ULL << 3,
94  TERM5_block = 1ULL << 4,
95  TERM6_block = 1ULL << 5,
96  HELIPAD1_block = 1ULL << 6,
97  HELIPAD2_block = 1ULL << 7,
98  RUNWAY_IN_OUT_block = 1ULL << 8,
99  RUNWAY_IN_block = 1ULL << 8,
100  AIRPORT_BUSY_block = 1ULL << 8,
101  RUNWAY_OUT_block = 1ULL << 9,
102  TAXIWAY_BUSY_block = 1ULL << 10,
103  OUT_WAY_block = 1ULL << 11,
104  IN_WAY_block = 1ULL << 12,
105  AIRPORT_ENTRANCE_block = 1ULL << 13,
106  TERM_GROUP1_block = 1ULL << 14,
107  TERM_GROUP2_block = 1ULL << 15,
108  HANGAR2_AREA_block = 1ULL << 16,
109  TERM_GROUP2_ENTER1_block = 1ULL << 17,
110  TERM_GROUP2_ENTER2_block = 1ULL << 18,
111  TERM_GROUP2_EXIT1_block = 1ULL << 19,
112  TERM_GROUP2_EXIT2_block = 1ULL << 20,
113  PRE_HELIPAD_block = 1ULL << 21,
114 
115  /* blocks for new airports */
116  TERM7_block = 1ULL << 22,
117  TERM8_block = 1ULL << 23,
118  HELIPAD3_block = 1ULL << 24,
119  HANGAR1_AREA_block = 1ULL << 26,
120  OUT_WAY2_block = 1ULL << 27,
121  IN_WAY2_block = 1ULL << 28,
122  RUNWAY_IN2_block = 1ULL << 29,
123  RUNWAY_OUT2_block = 1ULL << 10,
124  HELIPAD_GROUP_block = 1ULL << 13,
125  OUT_WAY_block2 = 1ULL << 31,
126  /* end of new blocks */
127 
128  NOTHING_block = 1ULL << 30,
129  AIRPORT_CLOSED_block = 1ULL << 63;
130 
133  int16 x;
134  int16 y;
135  uint16 flag;
137 };
138 
139 AirportMovingData RotateAirportMovingData(const AirportMovingData *orig, Direction rotation, uint num_tiles_x, uint num_tiles_y);
140 
141 struct AirportFTAbuildup;
142 
145 public:
147  enum Flags {
148  AIRPLANES = 0x1,
149  HELICOPTERS = 0x2,
150  ALL = AIRPLANES | HELICOPTERS,
151  SHORT_STRIP = 0x4,
152  };
153 
155  const AirportMovingData *moving_data,
156  const byte *terminals,
157  const byte num_helipads,
158  const byte *entry_points,
159  Flags flags,
160  const AirportFTAbuildup *apFA,
161  byte delta_z
162  );
163 
164  ~AirportFTAClass();
165 
171  const AirportMovingData *MovingData(byte position) const
172  {
173  assert(position < nofelements);
174  return &moving_data[position];
175  }
176 
178  struct AirportFTA *layout;
179  const byte *terminals;
180  const byte num_helipads;
182  byte nofelements;
183  const byte *entry_points;
184  byte delta_z;
185 };
186 
188 
189 
190 
191 struct AirportFTA {
192  AirportFTA *next;
193  uint64 block;
194  byte position;
196  byte heading;
197 };
198 
199 const AirportFTAClass *GetAirport(const byte airport_type);
200 byte GetVehiclePosOnBuild(TileIndex hangar_tile);
201 
202 #endif /* AIRPORT_H */
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Airplane wants to leave the airport.
Definition: airport.h:73
Different types to &#39;show&#39; directions.
Heading for hangar.
Definition: airport.h:64
Heading for terminal 1.
Definition: airport.h:65
Airplane has reached end-point of the take-off runway.
Definition: airport.h:75
Finite sTate mAchine (FTA) of an airport.
Definition: airport.h:144
Heading for helipad 2.
Definition: airport.h:72
byte nofelements
number of positions the airport consists of
Definition: airport.h:182
Takeoff movement.
Definition: airport.h:51
byte next_position
next position from this position
Definition: airport.h:195
Last valid target to head for.
Definition: airport.h:85
static const uint64 HELIPAD1_block
Block belonging to helipad 1.
Definition: airport.h:96
A single location on an airport where aircraft can move to.
Definition: airport.h:132
static const uint64 TERM6_block
Block belonging to terminal 6.
Definition: airport.h:95
No speed restrictions.
Definition: airport.h:50
Dummy airport.
Definition: airport.h:45
Heading for terminal 6.
Definition: airport.h:70
Helicopter landing.
Definition: airport.h:57
Large airport.
Definition: airport.h:32
Taxiing at the airport.
Definition: airport.h:55
const byte * entry_points
when an airplane arrives at this airport, enter it at position entry_point, index depends on directio...
Definition: airport.h:183
static const uint INVALID_AIRPORTTILE
id for an invalid airport tile
Definition: airport.h:27
State machine input struct (from external file, etc.) Finite sTate mAchine –> FTA.
Flags flags
Flags for this airport type.
Definition: airport.h:181
int16 y
y-coordinate of the destination.
Definition: airport.h:134
Vehicle is flying in the air.
Definition: airport.h:77
AirportMovingDataFlags
Flags for airport movement data.
Definition: airport.h:49
static const uint64 HELIPAD3_block
Block belonging to helipad 3.
Definition: airport.h:118
Helicopter wants to land.
Definition: airport.h:80
Heli station airport.
Definition: airport.h:39
Go exactly to the destination coordinates.
Definition: airport.h:54
Direction
Defines the 8 directions on the map.
byte GetVehiclePosOnBuild(TileIndex hangar_tile)
Get the vehicle position when an aircraft is build at the given tile.
Definition: airport.cpp:220
Holding pattern movement (above the airport).
Definition: airport.h:58
static const uint64 HELIPAD2_block
Block belonging to helipad 2.
Definition: airport.h:97
Invalid airport.
Definition: airport.h:44
Commuter airport.
Definition: airport.h:36
Maximal number of airports in total.
Definition: airport.h:43
Flags
Bitmask of airport flags.
Definition: airport.h:147
Turn slowly (mostly used in the air).
Definition: airport.h:52
Number of the first newgrf airport.
Definition: airport.h:41
Internal structure used in openttd - Finite sTate mAchine –> FTA.
Definition: airport.h:191
Heading for terminal 7.
Definition: airport.h:82
Heading for terminal 2.
Definition: airport.h:66
const byte num_helipads
Number of helipads on this airport. When 0 helicopters will go to normal terminals.
Definition: airport.h:180
static const uint64 AIRPORT_CLOSED_block
Dummy block for indicating a closed airport.
Definition: airport.h:129
Metropolitan airport.
Definition: airport.h:34
struct AirportFTA * layout
state machine for airport
Definition: airport.h:178
static const uint NUM_AIRPORTTILES_PER_GRF
Number of airport tiles per NewGRF; limited to 255 to allow extending Action3 with an extended byte l...
Definition: airport.h:23
static const uint NUM_AIRPORTTILES
Total number of airport tiles.
Definition: airport.h:25
const AirportFTAClass * GetAirport(const byte airport_type)
Get the finite state machine of an airport type.
Definition: airport.cpp:209
Heading for helipad 3.
Definition: airport.h:84
Heading for terminal 3.
Definition: airport.h:67
Airplane has arrived at a runway for take-off.
Definition: airport.h:74
const AirportMovingData * MovingData(byte position) const
Get movement data at a position.
Definition: airport.h:171
AirportMovingData RotateAirportMovingData(const AirportMovingData *orig, Direction rotation, uint num_tiles_x, uint num_tiles_y)
Rotate the airport moving data to another rotation.
Definition: airport.cpp:82
const AirportMovingData * moving_data
Movement data.
Definition: airport.h:177
AirportMovementStates
Movement States on Airports (headings target)
Definition: airport.h:62
static const uint MAX_HELIPADS
maximum number of helipads per airport
Definition: airport.h:20
Small airport.
Definition: airport.h:31
static const uint MAX_TERMINALS
Some airport-related constants.
Definition: airport.h:19
Heli depot.
Definition: airport.h:37
Go in this direction for every target.
Definition: airport.h:63
static const uint MAX_ELEMENTS
maximum number of aircraft positions at airport
Definition: airport.h:21
Maximal number of airports per NewGRF.
Definition: airport.h:42
static const uint64 TERM7_block
Block belonging to terminal 7.
Definition: airport.h:116
Oilrig airport.
Definition: airport.h:40
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
Airplane wants to land.
Definition: airport.h:78
static const uint64 TERM1_block
Movement Blocks on Airports blocks (eg_airport_flags).
Definition: airport.h:90
uint64 block
64 bit blocks (st->airport.flags), should be enough for the most complex airports ...
Definition: airport.h:193
Heli port.
Definition: airport.h:33
Heading for terminal 8.
Definition: airport.h:83
static const uint64 TERM8_block
Block belonging to terminal 8.
Definition: airport.h:117
int16 x
x-coordinate of the destination.
Definition: airport.h:133
AirportFTA * next
possible extra movement choices from this position
Definition: airport.h:192
static const uint64 TERM4_block
Block belonging to terminal 4.
Definition: airport.h:93
Heading for terminal 5.
Definition: airport.h:69
static const uint64 RUNWAY_OUT2_block
Definition: airport.h:123
Heading for terminal 4.
Definition: airport.h:68
Intercontinental airport.
Definition: airport.h:38
Landing onto landing strip.
Definition: airport.h:53
Heading for helipad 1.
Definition: airport.h:71
Helicopter wants to finish landing.
Definition: airport.h:81
static const uint64 HELIPAD_GROUP_block
Definition: airport.h:124
Helicopter take-off.
Definition: airport.h:56
uint16 flag
special flags when moving towards the destination.
Definition: airport.h:135
static const uint NEW_AIRPORTTILE_OFFSET
offset of first newgrf airport tile
Definition: airport.h:26
static const uint64 TERM3_block
Block belonging to terminal 3.
Definition: airport.h:92
static const uint64 TERM2_block
Block belonging to terminal 2.
Definition: airport.h:91
byte heading
heading (current orders), guiding an airplane to its target on an airport
Definition: airport.h:196
DirectionByte direction
Direction to turn the aircraft after reaching the destination.
Definition: airport.h:136
byte position
the position that an airplane is at
Definition: airport.h:194
Types related to tiles.
International airport.
Definition: airport.h:35
const byte * terminals
Array with the number of terminal groups, followed by the number of terminals in each group...
Definition: airport.h:179
AirportTypes
Airport types.
Definition: airport.h:30
Airplane wants to finish landing.
Definition: airport.h:79
byte delta_z
Z adjustment for helicopter pads.
Definition: airport.h:184
Helicopter wants to leave the airport.
Definition: airport.h:76
static const uint64 TERM5_block
Block belonging to terminal 5.
Definition: airport.h:94