summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorzuu <zuu@openttd.org>2013-12-17 20:41:51 +0000
committerzuu <zuu@openttd.org>2013-12-17 20:41:51 +0000
commitb2f2a017b1581dd9a106216a5018540a8dc3e118 (patch)
treec2d079249f8ad63bd4b9d0dd0eed0b4e9617c621
parent6817e97898b5550d3284ee0b25ab5ac104c423d6 (diff)
downloadopenttd-b2f2a017b1581dd9a106216a5018540a8dc3e118.tar.xz
(svn r26164) -Doc: Fix Game Script API docs on that deity can build/prospect independent of advanced setting for that
-rw-r--r--src/script/api/script_industrytype.hpp11
1 files changed, 8 insertions, 3 deletions
diff --git a/src/script/api/script_industrytype.hpp b/src/script/api/script_industrytype.hpp
index bae0919e9..8dccc68c9 100644
--- a/src/script/api/script_industrytype.hpp
+++ b/src/script/api/script_industrytype.hpp
@@ -112,7 +112,9 @@ public:
* @param industry_type The type of the industry.
* @pre IsValidIndustryType(industry_type).
* @return True if you can build this type of industry at locations of your choice.
- * @note Returns false if you can only prospect this type of industry, or not build it at all.
+ * @ai @note Returns false if you can only prospect this type of industry, or not build it at all.
+ * @game @note If no valid ScriptCompanyMode active in scope, this method returns false if you can
+ * @game only prospect this type of industry, or not build it at all.
* @game @note If no valid ScriptCompanyMode active in scope, the script can
* @game build as long as the industry type can be built. (a NewGRF can for example
* @game reject construction based on current year)
@@ -124,8 +126,11 @@ public:
* @param industry_type The type of the industry.
* @pre IsValidIndustryType(industry_type).
* @return True if you can prospect this type of industry.
- * @note If the setting "Manual primary industry construction method" is set
- * to either "None" or "as other industries" this function always returns false.
+ * @ai @note If the setting "Manual primary industry construction method" is set
+ * @ai to either "None" or "as other industries" this function always returns false.
+ * @game @note If no valid ScriptCompanyMode is active in scope, and if the setting
+ * @game "Manual primary industry construction method" is set to either "None" or
+ * @game "as other industries" this function always returns false.
* @game @note If no valid ScriptCompanyMode active in scope, the script can
* @game prospect as long as the industry type can be built. (a NewGRF can for
* @game example reject construction based on current year)