summaryrefslogtreecommitdiff
path: root/src/script/api
diff options
context:
space:
mode:
authortruebrain <truebrain@openttd.org>2011-12-19 20:57:08 +0000
committertruebrain <truebrain@openttd.org>2011-12-19 20:57:08 +0000
commit1616961ea2c1fa84c41d7df9af535fbb190d2c41 (patch)
tree4ff03a081e56d7f81491dfb06d1d2257a87bcb82 /src/script/api
parent963802e9a7cb67f51cb7e6ffe9d33a02cfe93821 (diff)
downloadopenttd-1616961ea2c1fa84c41d7df9af535fbb190d2c41.tar.xz
(svn r23613) -Add: allow IsDeveloperOnly in info.nut, to indicate if you can select this GS via the GUI (optional, defaults to false)
Diffstat (limited to 'src/script/api')
-rw-r--r--src/script/api/script_info_docs.hpp13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/script/api/script_info_docs.hpp b/src/script/api/script_info_docs.hpp
index 10d2f09f7..dd7673294 100644
--- a/src/script/api/script_info_docs.hpp
+++ b/src/script/api/script_info_docs.hpp
@@ -130,6 +130,19 @@ public:
bool UseAsRandomAI();
/**
+ * Can a non-developer select Script for a new game.
+ *
+ * The idea behind this function is to 'forbid' using your script with a new
+ * game if you for example specificly wrote it for a certain scenario.
+ *
+ * @return True if the Script can be selected from the GUI as non-developer.
+ * @note This function is optional. Default is false.
+ *
+ * @api -ai
+ */
+ bool IsDeveloperOnly();
+
+ /**
* Gets the name of main class of the Script so OpenTTD knows
* what class to instantiate.
*