(svn r20798) -Doc [FS#4117]: [NoAI] AITile::HasTransportType doesn't work for TRANSPORT_AIR

This commit is contained in:
yexo 2010-09-13 13:36:36 +00:00
parent 2d4c5ea668
commit 4d1f24330f
1 changed files with 4 additions and 0 deletions

View File

@ -298,10 +298,14 @@ public:
* @param tile The tile to check.
* @param transport_type The TransportType to check against.
* @pre AIMap::IsValidTile(tile).
* @pre transport_type != TRANSPORT_AIR.
* @note Returns false on tiles with roadworks and on road tiles with only
* a single piece of road as these tiles cannot be used to transport
* anything on. It furthermore returns true on some coast tile for
* TRANSPORT_WATER because ships can navigate over them.
* @note Use AIAirport.IsAirportTile to check for airport tiles. Aircraft
* can fly over every tile on the map so using HasTransportType
* doesn't make sense for TRANSPORT_AIR.
* @return True if and only if the tile has the given TransportType.
*/
static bool HasTransportType(TileIndex tile, TransportType transport_type);