dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r27287) -Doc: Clarify radius and semantics of the industry producing/accepting tile functions.

Browse Source
This commit is contained in:
alberth
2015-05-16 14:40:45 +00:00
parent ad8a7aee30
commit ada765a7e1
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/script/api/script_tilelist.hpp
View File

@@ -65,9 +65,10 @@ class ScriptTileList_IndustryAccepting : public ScriptTileList {
public: public:
/** /**
* @param industry_id The industry to create the ScriptTileList around. * @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 ScriptIndustry::IsValidIndustry(industry_id).
* @pre radius > 0. * @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); ScriptTileList_IndustryAccepting(IndustryID industry_id, int radius);
}; };
@@ -82,9 +83,10 @@ class ScriptTileList_IndustryProducing : public ScriptTileList {
public: public:
/** /**
* @param industry_id The industry to create the ScriptTileList around. * @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 ScriptIndustry::IsValidIndustry(industry_id).
* @pre radius > 0. * @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); ScriptTileList_IndustryProducing(IndustryID industry_id, int radius);
}; };