diff options
| author | George Marques <george@gmarqu.es> | 2023-04-19 11:10:35 -0300 |
|---|---|---|
| committer | George Marques <george@gmarqu.es> | 2023-04-27 09:51:44 -0300 |
| commit | 0ba6048ad3c945e2bd1d0114b5095535c22103ce (patch) | |
| tree | e9d17e159dab50dc6cc3d574a25647af01939d6c /modules/gdscript/doc_classes | |
| parent | 352ebe97259622f20b47627b4bf747cdfc79304d (diff) | |
| download | redot-engine-0ba6048ad3c945e2bd1d0114b5095535c22103ce.tar.gz | |
Add support for static variables in GDScript
Which allows editable data associated with a particular class instead of
the instance. Scripts with static variables are kept in memory
indefinitely unless the `@static_unload` annotation is used or the
`static_unload()` method is called on the GDScript.
If the custom function `_static_init()` exists it will be called when
the class is loaded, after the static variables are set.
Diffstat (limited to 'modules/gdscript/doc_classes')
| -rw-r--r-- | modules/gdscript/doc_classes/@GDScript.xml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index 08a4883054..d8f12f7232 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -622,6 +622,12 @@ [/codeblock] </description> </annotation> + <annotation name="@static_unload"> + <return type="void" /> + <description> + Make a script with static variables to not persist after all references are lost. If the script is loaded again the static variables will revert to their default values. + </description> + </annotation> <annotation name="@tool"> <return type="void" /> <description> |