Mercurial > hg > openttd
changeset 15578:37254d8be435 draft
(svn r20238) -Doc: [NoAI] clarify the documentation for AIBaseStation::GetLocation
| author | yexo <yexo@openttd.org> |
|---|---|
| date | Thu, 29 Jul 2010 13:08:57 +0000 |
| parents | c5abee0724a9 |
| children | 5f128be91f59 |
| files | src/ai/api/ai_basestation.hpp |
| diffstat | 1 files changed, 3 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/src/ai/api/ai_basestation.hpp +++ b/src/ai/api/ai_basestation.hpp @@ -64,7 +64,9 @@ * 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);