summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoryexo <yexo@openttd.org>2010-08-02 23:09:38 +0000
committeryexo <yexo@openttd.org>2010-08-02 23:09:38 +0000
commit689d4bef04462173335be7f7973d67d353910783 (patch)
treef00c571f182f425a995332819431b1e7950aee3a
parentaae7ef73bb11f786683fe1b4cd897938d6b0691a (diff)
downloadopenttd-689d4bef04462173335be7f7973d67d353910783.tar.xz
(svn r20331) -Doc: some more airport-related code
-rw-r--r--src/airport.h18
-rw-r--r--src/newgrf_airport.cpp1
-rw-r--r--src/newgrf_airport.h9
3 files changed, 16 insertions, 12 deletions
diff --git a/src/airport.h b/src/airport.h
index 0733c9ab2..288a79a05 100644
--- a/src/airport.h
+++ b/src/airport.h
@@ -128,11 +128,12 @@ static const uint64
NOTHING_block = 1ULL << 30;
+/** A single location on an airport where aircraft can move to. */
struct AirportMovingData {
- int16 x;
- int16 y;
- uint16 flag;
- DirectionByte direction;
+ int16 x; ///< x-coordinate of this position
+ int16 y; ///< y-coordinate of this position
+ uint16 flag; ///< special flags when moving towards this position
+ DirectionByte direction; ///< Direction to turn the aircraft after reaching this position.
};
struct AirportFTAbuildup;
@@ -140,11 +141,12 @@ struct AirportFTAbuildup;
/** Finite sTate mAchine --> FTA */
struct AirportFTAClass {
public:
+ /** Bitmask of airport flags. */
enum Flags {
- AIRPLANES = 0x1,
- HELICOPTERS = 0x2,
- ALL = AIRPLANES | HELICOPTERS,
- SHORT_STRIP = 0x4
+ AIRPLANES = 0x1, ///< Can planes land on this airport type?
+ HELICOPTERS = 0x2, ///< Can helicopters land on this airport type?
+ ALL = AIRPLANES | HELICOPTERS, ///< Mask to check for both planes and helicopters.
+ SHORT_STRIP = 0x4 ///< This airport has a short landing strip, dangerous for fast aircraft.
};
AirportFTAClass(
diff --git a/src/newgrf_airport.cpp b/src/newgrf_airport.cpp
index 4fc94db7c..c4cc9e486 100644
--- a/src/newgrf_airport.cpp
+++ b/src/newgrf_airport.cpp
@@ -56,6 +56,7 @@ AirportSpec AirportSpec::specs[NUM_AIRPORTS];
return &AirportSpec::specs[type];
}
+/** Check if this airport is available to build. */
bool AirportSpec::IsAvailable() const
{
if (!this->enabled) return false;
diff --git a/src/newgrf_airport.h b/src/newgrf_airport.h
index c2200918d..bcaa7e274 100644
--- a/src/newgrf_airport.h
+++ b/src/newgrf_airport.h
@@ -20,9 +20,10 @@
/* Copy from station_map.h */
typedef byte StationGfx;
+/** Tile-offset / AirportTileID pair. */
struct AirportTileTable {
- TileIndexDiffC ti;
- StationGfx gfx;
+ TileIndexDiffC ti; ///< Tile offset from the top-most airport tile.
+ StationGfx gfx; ///< AirportTile to use for this tile.
};
/** List of default airport classes. */
@@ -48,8 +49,8 @@ enum TTDPAirportType {
/** A list of all hangar tiles in an airport */
struct HangarTileTable {
- TileIndexDiffC ti;
- byte hangar_num;
+ TileIndexDiffC ti; ///< Tile offset from the top-most airport tile.
+ byte hangar_num; ///< The hanger to which this tile belongs.
};
/**