(svn r16243) -Fix [FS#2875]: CmdBuildTunnel could be called with invalid parameters from the api code, causing crashes later

1 files changed, 5 insertions, 1 deletions

diff --git a/src/ai/api/ai_tunnel.hpp b/src/ai/api/ai_tunnel.hpp
index 3e554b68c..de0a7635c 100644
--- a/src/ai/api/ai_tunnel.hpp
+++ b/src/ai/api/ai_tunnel.hpp
@@ -46,11 +46,15 @@ public:
 
 	/**
 	 * Get the tile that exits on the other end of a (would be) tunnel starting
-	 *  at tile.
+	 *  at tile. If there is no 'simple' inclined slope at the start tile,
+	 *  this function will return AIMap::TILE_INVALID.
 	 * @param tile The tile that is an entrance to a tunnel or the tile where you may want to build a tunnel.
 	 * @pre AIMap::IsValidTile(tile).
 	 * @return The TileIndex that is the other end of the (would be) tunnel, or
 	 *  AIMap::TILE_INVALID if no other end was found (can't build tunnel).
+	 * @note Even if this function returns a valid tile, that is no guarantee
+	 *  that building a tunnel will succeed. Use BuildTunnel in AITestMode to
+	 *  check whether a tunnel can actually be build.
 	 */
 	static TileIndex GetOtherTunnelEnd(TileIndex tile);