changeset 17954:308f37bdda95 draft

(svn r22763) -Fix [FS#4702]: Clarify the meaning of AIStation::IsWithinTownInfluence(), AITile::IsWithinTownInfluence() and AITown::IsWithinTownInfluence().
author frosch <frosch@openttd.org>
date Fri, 19 Aug 2011 21:18:32 +0000
parents e47ec55fd8e7
children daeef82dcf7e
files src/ai/api/ai_station.hpp src/ai/api/ai_tile.hpp src/ai/api/ai_town.hpp
diffstat 3 files changed, 6 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/src/ai/api/ai_station.hpp
+++ b/src/ai/api/ai_station.hpp
@@ -117,7 +117,8 @@
 
 	/**
 	 * Find out if this station is within the rating influence of a town.
-	 *  Stations within the radius influence the rating of the town.
+	 *  The service quality of stations with signs within this radius
+	 *  influences the rating of the town.
 	 * @param station_id The station to check.
 	 * @param town_id The town to check.
 	 * @return True if the tile is within the rating influence of the town.
--- a/src/ai/api/ai_tile.hpp
+++ b/src/ai/api/ai_tile.hpp
@@ -441,7 +441,8 @@
 
 	/**
 	 * Find out if this tile is within the rating influence of a town.
-	 *  Stations on this tile influence the rating of the town.
+	 *  If a station sign would be on this tile, the servicing quality of the station would
+	 *  influence the rating of the town.
 	 * @param tile The tile to check.
 	 * @param town_id The town to check.
 	 * @return True if the tile is within the rating influence of the town.
--- a/src/ai/api/ai_town.hpp
+++ b/src/ai/api/ai_town.hpp
@@ -209,7 +209,8 @@
 
 	/**
 	 * Find out if this tile is within the rating influence of a town.
-	 *  Stations on this tile influence the rating of the town.
+	 *  If a station sign would be on this tile, the servicing quality of the station would
+	 *  influence the rating of the town.
 	 * @param town_id The town to check.
 	 * @param tile The tile to check.
 	 * @pre IsValidTown(town_id).