gronod/OpenTTD
1
0
Fork 0
mirror of https://github.com/OpenTTD/OpenTTD.git synced 2025-03-12 02:19:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

(svn r26010) -Document [FS#5662]: The AI/GS library name to use in Import, is not the name given by GetName but GetInstanceName

Browse Source
This commit is contained in:
zuu 2013-11-16 12:33:45 +00:00
parent 3b9f92e14c
commit 41b07b571d
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/script/api/script_controller.hpp
View File

@ -127,7 +127,8 @@ public:
/** /**
* Import a library. * 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 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. * @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. * @return The loaded library object. If class_name is set, it is also available (under the scope of the import) under that name.

12
src/script/api/script_info_docs.hpp
View File

@ -18,9 +18,10 @@
* Scripts must or can implemented to provide information to OpenTTD to * Scripts must or can implemented to provide information to OpenTTD to
* base configuring/starting/loading the Script on. * base configuring/starting/loading the Script on.
* *
* @note The required functions are also needed for Script Libraries. As such * @note The required functions are also needed for Script Libraries, but in
* the information here can be used for libraries, but the information * that case you extend ScriptLibrary. As such the information here can
* will not be shown in the GUI except for error/debug messages. * be used for libraries, but the information will not be shown in the
* GUI except for error/debug messages.
* *
* @api ai game * @api ai game
*/ */
@ -43,6 +44,8 @@ public:
* *
* @return The name of the Script. * @return The name of the Script.
* @note This function is required. * @note This function is required.
* @note This name is not used as library name by ScriptController::Import,
* instead the name returned by #CreateInstance is used.
*/ */
string GetName(); string GetName();
@ -144,7 +147,8 @@ public:
/** /**
* Gets the name of main class of the Script so OpenTTD knows * Gets the name of main class of the Script so OpenTTD knows
* what class to instantiate. * what class to instantiate. For libraries, this name is also
* used when other scripts import it using @ScriptController::Import.
* *
* @return The class name of the Script. * @return The class name of the Script.
* @note This function is required. * @note This function is required.