summaryrefslogtreecommitdiff
path: root/src/script
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2015-05-16 14:40:45 +0000
committeralberth <alberth@openttd.org>2015-05-16 14:40:45 +0000
commit514da346bdfb94422d0e0c57eeaebea80b3db071 (patch)
tree6c5f6ddb03ea48bc548f9f49edeae64502b050a3 /src/script
parent10adedce5f7210d07bb085dc12598ed0db79bae8 (diff)
downloadopenttd-514da346bdfb94422d0e0c57eeaebea80b3db071.tar.xz
(svn r27287) -Doc: Clarify radius and semantics of the industry producing/accepting tile functions.
Diffstat (limited to 'src/script')
-rw-r--r--src/script/api/script_tilelist.hpp6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/script/api/script_tilelist.hpp b/src/script/api/script_tilelist.hpp
index 74c3afa52..788432f78 100644
--- a/src/script/api/script_tilelist.hpp
+++ b/src/script/api/script_tilelist.hpp
@@ -65,9 +65,10 @@ class ScriptTileList_IndustryAccepting : public ScriptTileList {
public:
/**
* @param industry_id The industry to create the ScriptTileList around.
- * @param radius The radius of the station you will be using.
+ * @param radius The coverage radius of the station type you will be using.
* @pre ScriptIndustry::IsValidIndustry(industry_id).
* @pre radius > 0.
+ * @note A station part built on any of the returned tiles will give you coverage.
*/
ScriptTileList_IndustryAccepting(IndustryID industry_id, int radius);
};
@@ -82,9 +83,10 @@ class ScriptTileList_IndustryProducing : public ScriptTileList {
public:
/**
* @param industry_id The industry to create the ScriptTileList around.
- * @param radius The radius of the station you will be using.
+ * @param radius The coverage radius of the station type you will be using.
* @pre ScriptIndustry::IsValidIndustry(industry_id).
* @pre radius > 0.
+ * @note A station part built on any of the returned tiles will give you acceptance.
*/
ScriptTileList_IndustryProducing(IndustryID industry_id, int radius);
};