diff options
| author | Emmanuel Leblond <emmanuel.leblond@gmail.com> | 2022-10-09 22:03:59 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2023-02-10 19:50:24 +0100 |
| commit | 58f4139164552793bfb16065e31388cdd2481492 (patch) | |
| tree | d65f62581e0aa8fa7bf5187adae1f35aec90bc54 /doc | |
| parent | ed85a2c8ceae048c2b29bc6ccf6f53a9c70ec811 (diff) | |
Add Engine::unregister_script_language and make Engine::register_script_language returns a Error
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Engine.xml | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index d583e07f59..461ffcb2e0 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -244,10 +244,14 @@ </description> </method> <method name="register_script_language"> - <return type="void" /> + <return type="int" enum="Error" /> <param index="0" name="language" type="ScriptLanguage" /> <description> Registers a [ScriptLanguage] instance to be available with [code]ScriptServer[/code]. + Returns: + - [constant OK] on success + - [constant ERR_UNAVAILABLE] if [code]ScriptServer[/code] has reached it limit and cannot register any new language + - [constant ERR_ALREADY_EXISTS] if [code]ScriptServer[/code] already contains a language with similar extension/name/type </description> </method> <method name="register_singleton"> @@ -258,6 +262,16 @@ Registers the given object as a singleton, globally available under [param name]. </description> </method> + <method name="unregister_script_language"> + <return type="int" enum="Error" /> + <param index="0" name="language" type="ScriptLanguage" /> + <description> + Unregisters the [ScriptLanguage] instance from [code]ScriptServer[/code]. + Returns: + - [constant OK] on success + - [constant ERR_DOES_NOT_EXIST] if the language is already not registered in [code]ScriptServer[/code] + </description> + </method> <method name="unregister_singleton"> <return type="void" /> <param index="0" name="name" type="StringName" /> |