summaryrefslogtreecommitdiff
path: root/modules/gdnative/doc_classes
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2019-10-06 22:26:04 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2019-10-07 15:59:57 +0200
commit9499eef4da14bea59e55fe663ce16fa151ef21f7 (patch)
tree35463d968dc83d79892b0a387fa2654dd9563c90 /modules/gdnative/doc_classes
parent7801fdfedb1298f46c7031ff92deb9c276eec11c (diff)
Document the GDNative singleton method prefix being changeable
This also tweaks error messages to remove hardcoded references to the default `godot_` prefix.
Diffstat (limited to 'modules/gdnative/doc_classes')
-rw-r--r--modules/gdnative/doc_classes/GDNativeLibrary.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/modules/gdnative/doc_classes/GDNativeLibrary.xml b/modules/gdnative/doc_classes/GDNativeLibrary.xml
index ae9a00543c..aa48ab44f2 100644
--- a/modules/gdnative/doc_classes/GDNativeLibrary.xml
+++ b/modules/gdnative/doc_classes/GDNativeLibrary.xml
@@ -39,7 +39,7 @@
[b]Note:[/b] If the library defines tool scripts that run inside the editor, [code]reloadable[/code] must be [code]false[/code]. Otherwise, the editor will attempt to unload the tool scripts while they're in use and crash.
</member>
<member name="singleton" type="bool" setter="set_singleton" getter="is_singleton" default="false">
- If [code]true[/code], Godot loads the library at startup rather than the first time a script uses the library, calling [code]gdnative_singleton[/code] after initializing the library. The library remains loaded as long as Godot is running.
+ If [code]true[/code], Godot loads the library at startup rather than the first time a script uses the library, calling [code]{prefix}gdnative_singleton[/code] after initializing the library (where [code]{prefix}[/code] is the value of [member symbol_prefix]). The library remains loaded as long as Godot is running.
[b]Note:[/b] A singleton library cannot be [member reloadable].
</member>
<member name="symbol_prefix" type="String" setter="set_symbol_prefix" getter="get_symbol_prefix" default="&quot;godot_&quot;">