--- a/src/ai/api/ai_marine.hpp Thu Feb 28 00:43:30 2008 +0000
+++ b/src/ai/api/ai_marine.hpp Thu Feb 28 00:59:01 2008 +0000
@@ -20,7 +20,7 @@
/**
* Checks whether the given tile is actually a tile with a water depot.
* @param tile the tile to check.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return true if and only if the tile has a water depot.
*/
static bool IsWaterDepotTile(TileIndex tile);
@@ -28,7 +28,7 @@
/**
* Checks whether the given tile is actually a tile with a dock.
* @param tile the tile to check.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return true if and only if the tile has a dock.
*/
static bool IsDockTile(TileIndex tile);
@@ -36,7 +36,7 @@
/**
* Checks whether the given tile is actually a tile with a buoy.
* @param tile the tile to check.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return true if and only if the tile has a buoy.
*/
static bool IsBuoyTile(TileIndex tile);
@@ -44,7 +44,7 @@
/**
* Checks whether the given tile is actually a tile with a lock.
* @param tile the tile to check.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return true if and only if the tile has a lock.
*/
static bool IsLockTile(TileIndex tile);
@@ -52,7 +52,7 @@
/**
* Checks whether the given tile is actually a tile with a canal.
* @param tile the tile to check.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return true if and only if the tile has a canal.
*/
static bool IsCanalTile(TileIndex tile);
@@ -61,7 +61,7 @@
* Builds a water depot on tile.
* @param tile the tile where the water depot will be build.
* @param vertical if true, depot will be vertical, else horizontal.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return whether the water depot has been/can be build or not.
*/
static bool BuildWaterDepot(TileIndex tile, bool vertical);
@@ -69,7 +69,7 @@
/**
* Builds a dock where tile is the tile still on land.
* @param tile the tile still on land of the dock.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return whether the dock has been/can be build or not.
*/
static bool BuildDock(TileIndex tile);
@@ -77,7 +77,7 @@
/**
* Builds a buoy on tile.
* @param tile the tile where the buoy will be build.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return whether the buoy has been/can be build or not.
*/
static bool BuildBuoy(TileIndex tile);
@@ -85,7 +85,7 @@
/**
* Builds a lock on tile.
* @param tile the tile where the lock will be build.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return whether the lock has been/can be build or not.
*/
static bool BuildLock(TileIndex tile);
@@ -93,7 +93,7 @@
/**
* Builds a canal on tile.
* @param tile the tile where the canal will be build.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return whether the canal has been/can be build or not.
*/
static bool BuildCanal(TileIndex tile);
@@ -101,7 +101,7 @@
/**
* Removes a water depot.
* @param tile any tile of the water depot.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return whether the water depot has been/can be removed or not.
*/
static bool RemoveWaterDepot(TileIndex tile);
@@ -109,7 +109,7 @@
/**
* Removes a dock.
* @param tile any tile of the dock.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return whether the dock has been/can be removed or not.
*/
static bool RemoveDock(TileIndex tile);
@@ -117,7 +117,7 @@
/**
* Removes a buoy.
* @param tile any tile of the buoy.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return whether the buoy has been/can be removed or not.
*/
static bool RemoveBuoy(TileIndex tile);
@@ -125,7 +125,7 @@
/**
* Removes a lock.
* @param tile any tile of the lock.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return whether the lock has been/can be removed or not.
*/
static bool RemoveLock(TileIndex tile);
@@ -133,7 +133,7 @@
/**
* Removes a canal.
* @param tile any tile of the canal.
- * @pre tile is always positive and smaller than AIMap::GetMapSize().
+ * @pre AIMap::IsValidTile(tile).
* @return whether the canal has been/can be removed or not.
*/
static bool RemoveCanal(TileIndex tile);