From 514da346bdfb94422d0e0c57eeaebea80b3db071 Mon Sep 17 00:00:00 2001 From: alberth Date: Sat, 16 May 2015 14:40:45 +0000 Subject: (svn r27287) -Doc: Clarify radius and semantics of the industry producing/accepting tile functions. --- src/script/api/script_tilelist.hpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'src/script/api/script_tilelist.hpp') 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); }; -- cgit v1.2.3-54-g00ecf