summaryrefslogtreecommitdiff
path: root/src/script/api/script_controller.hpp
diff options
context:
space:
mode:
authorzuu <zuu@openttd.org>2013-11-16 12:33:45 +0000
committerzuu <zuu@openttd.org>2013-11-16 12:33:45 +0000
commit41b07b571d3a55acda841cfbede1d5b03b38b757 (patch)
treea32567b1184100929cdee97743a18f5d44538824 /src/script/api/script_controller.hpp
parent3b9f92e14cab0cb08697646d917af81f47144854 (diff)
downloadopenttd-41b07b571d3a55acda841cfbede1d5b03b38b757.tar.xz
(svn r26010) -Document [FS#5662]: The AI/GS library name to use in Import, is not the name given by GetName but GetInstanceName
Diffstat (limited to 'src/script/api/script_controller.hpp')
-rw-r--r--src/script/api/script_controller.hpp3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/script/api/script_controller.hpp b/src/script/api/script_controller.hpp
index 20a849fc8..10fd48dcd 100644
--- a/src/script/api/script_controller.hpp
+++ b/src/script/api/script_controller.hpp
@@ -127,7 +127,8 @@ public:
/**
* Import a library.
- * @param library The name of the library to import.
+ * @param library The name of the library to import. The name should be composed as ScriptInfo::GetCategory() + "." +
+ * ScriptInfo::CreateInstance().
* @param class_name Under which name you want it to be available (or "" if you just want the returning object).
* @param version Which version you want specifically.
* @return The loaded library object. If class_name is set, it is also available (under the scope of the import) under that name.