summaryrefslogtreecommitdiff
path: root/src/ai/api/ai_tile.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/ai/api/ai_tile.hpp')
-rw-r--r--src/ai/api/ai_tile.hpp8
1 files changed, 3 insertions, 5 deletions
diff --git a/src/ai/api/ai_tile.hpp b/src/ai/api/ai_tile.hpp
index 6b254899f..9ba0df031 100644
--- a/src/ai/api/ai_tile.hpp
+++ b/src/ai/api/ai_tile.hpp
@@ -309,9 +309,8 @@ public:
static int32 GetCargoAcceptance(TileIndex tile, CargoID cargo_type, int width, int height, int radius);
/**
- * Checks how many tiles in the radius produces this cargo.
- * It creates a radius around the tile, and adds up all tiles that produce
- * this cargo.
+ * Checks how many producers in the radius produces this cargo.
+ * It creates a radius around the tile, and counts all producer of this cargo.
* @param tile The tile to check on.
* @param cargo_type The cargo to check the production of.
* @param width The width of the station.
@@ -321,8 +320,7 @@ public:
* @pre width > 0.
* @pre height > 0.
* @pre radius >= 0.
- * @return The tiles that produce this cargo within radius of the tile.
- * @note Town(houses) are not included in the value.
+ * @return The number of producers that produce this cargo within radius of the tile.
*/
static int32 GetCargoProduction(TileIndex tile, CargoID cargo_type, int width, int height, int radius);