summaryrefslogtreecommitdiff
path: root/src/ai/api
diff options
context:
space:
mode:
authoryexo <yexo@openttd.org>2010-07-29 13:08:57 +0000
committeryexo <yexo@openttd.org>2010-07-29 13:08:57 +0000
commit04242e19cf29aedca783f4657e2c448d40f37420 (patch)
tree70d665243f4c8c194bd4f0d1d30efb7e28f9048a /src/ai/api
parente8cabbdc56c08f17f39319992eaf062e4dc2fed6 (diff)
downloadopenttd-04242e19cf29aedca783f4657e2c448d40f37420.tar.xz
(svn r20238) -Doc: [NoAI] clarify the documentation for AIBaseStation::GetLocation
Diffstat (limited to 'src/ai/api')
-rw-r--r--src/ai/api/ai_basestation.hpp4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/ai/api/ai_basestation.hpp b/src/ai/api/ai_basestation.hpp
index 3ced2bf56..4fe0af984 100644
--- a/src/ai/api/ai_basestation.hpp
+++ b/src/ai/api/ai_basestation.hpp
@@ -64,7 +64,9 @@ public:
* Get the current location of a basestation.
* @param station_id The basestation to get the location of.
* @pre IsValidBaseStation(station_id).
- * @return The tile the basestation is currently on.
+ * @return The tile the basestation sign above it.
+ * @note The tile is not necessarily a station tile (and if it is, it could also belong to another station).
+ * @see AITileList_StationType.
*/
static TileIndex GetLocation(StationID station_id);