diff options
Diffstat (limited to 'src/script/api/script_info_docs.hpp')
| -rw-r--r-- | src/script/api/script_info_docs.hpp | 13 |
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. * |