summaryrefslogtreecommitdiff
path: root/src/ai/api/ai_airport.hpp
diff options
context:
space:
mode:
authoryexo <yexo@openttd.org>2009-09-20 18:38:43 +0000
committeryexo <yexo@openttd.org>2009-09-20 18:38:43 +0000
commit12ef0046dde205e0e111ed7e6d830ea4f93c45c9 (patch)
tree725c12c7662b29bea2b46b1ed10469a1fa44947c /src/ai/api/ai_airport.hpp
parent64ed7cc8de1dd551e9222119ec75465371494f3b (diff)
downloadopenttd-12ef0046dde205e0e111ed7e6d830ea4f93c45c9.tar.xz
(svn r17591) -Add [NoAI] [FS#3212]: AIAirport::IsAirportInformationAvailable. Also update several preconditions so it's now possible to get information on airports types that can no longer be build (small airport after 1960)
Diffstat (limited to 'src/ai/api/ai_airport.hpp')
-rw-r--r--src/ai/api/ai_airport.hpp16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/ai/api/ai_airport.hpp b/src/ai/api/ai_airport.hpp
index 344cec64a..f0c52bc45 100644
--- a/src/ai/api/ai_airport.hpp
+++ b/src/ai/api/ai_airport.hpp
@@ -57,12 +57,24 @@ public:
* Checks whether the given AirportType is valid and available.
* @param type The AirportType to check.
* @return True if and only if the AirportType is valid and available.
+ * @post return value == true -> IsAirportInformationAvailable returns true.
*/
static bool IsValidAirportType(AirportType type);
/**
+ * Can you get information on this airport type? As opposed to
+ * IsValidAirportType this will return also return true when
+ * an airport type is no longer buildable.
+ * @param type The AirportType to check.
+ * @return True if and only if the AirportType is valid.
+ * @post return value == false -> IsValidAirportType returns false.
+ */
+ static bool IsAirportInformationAvailable(AirportType type);
+
+ /**
* Get the cost to build this AirportType.
* @param type The AirportType to check.
+ * @pre AirportAvailable(type).
* @return The cost of building this AirportType.
*/
static Money GetPrice(AirportType type);
@@ -86,6 +98,7 @@ public:
/**
* Get the width of this type of airport.
* @param type The type of airport.
+ * @pre IsAirportInformationAvailable(type).
* @return The width in tiles.
*/
static int32 GetAirportWidth(AirportType type);
@@ -93,6 +106,7 @@ public:
/**
* Get the height of this type of airport.
* @param type The type of airport.
+ * @pre IsAirportInformationAvailable(type).
* @return The height in tiles.
*/
static int32 GetAirportHeight(AirportType type);
@@ -100,6 +114,7 @@ public:
/**
* Get the coverage radius of this type of airport.
* @param type The type of airport.
+ * @pre IsAirportInformationAvailable(type).
* @return The radius in tiles.
*/
static int32 GetAirportCoverageRadius(AirportType type);
@@ -174,6 +189,7 @@ public:
* an airport at some tile.
* @param tile The tile to check.
* @param type The AirportType to check.
+ * @pre IsAirportInformationAvailable(type).
* @return The TownID of the town closest to the tile.
*/
static TownID GetNearestTown(TileIndex tile, AirportType type);