summaryrefslogtreecommitdiffstats
path: root/modules/gdscript/doc_classes
diff options
context:
space:
mode:
authorDanil Alexeev <danil@alexeev.xyz>2023-12-19 20:56:30 +0300
committerDanil Alexeev <danil@alexeev.xyz>2023-12-19 20:56:30 +0300
commit3a3a2011f4e5fae48fb3d556a15fda0206f92671 (patch)
tree776ff2341aff9d822efb475ba977a39e95f8d501 /modules/gdscript/doc_classes
parent1f5d4a62e9e9a8227ad63155b080fbbfac899571 (diff)
downloadredot-engine-3a3a2011f4e5fae48fb3d556a15fda0206f92671.tar.gz
GDScript: Add `@export_storage` annotation
Diffstat (limited to 'modules/gdscript/doc_classes')
-rw-r--r--modules/gdscript/doc_classes/@GDScript.xml11
1 files changed, 11 insertions, 0 deletions
diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml
index fcb7a11a14..dcca12ab7d 100644
--- a/modules/gdscript/doc_classes/@GDScript.xml
+++ b/modules/gdscript/doc_classes/@GDScript.xml
@@ -598,6 +598,17 @@
[/codeblock]
</description>
</annotation>
+ <annotation name="@export_storage">
+ <return type="void" />
+ <description>
+ Export a property with [constant PROPERTY_USAGE_STORAGE] flag. The property is not displayed in the editor, but it is serialized and stored in the scene or resource file. This can be useful for [annotation @tool] scripts. Also the property value is copied when [method Resource.duplicate] or [method Node.duplicate] is called, unlike non-exported variables.
+ [codeblock]
+ var a # Not stored in the file, not displayed in the editor.
+ @export_storage var b # Stored in the file, not displayed in the editor.
+ @export var c: int # Stored in the file, displayed in the editor.
+ [/codeblock]
+ </description>
+ </annotation>
<annotation name="@export_subgroup">
<return type="void" />
<param index="0" name="name" type="String" />