summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorLevi Lindsey <4317587+levilindsey@users.noreply.github.com>2021-06-15 20:00:19 -0700
committerLevi Lindsey <4317587+levilindsey@users.noreply.github.com>2021-06-15 20:00:19 -0700
commit2b7c0cfb344c3c430f52c4aeef1e05c83da62f91 (patch)
tree4f92616fa2e2a54f4edb578f3252bc7705e9ebdb /doc/classes
parent58c123511167cf5679d3bcf19f66efe8dbfd4db0 (diff)
Update File.store_var description to mention which properties of an object are included.
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/File.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/File.xml b/doc/classes/File.xml
index ea3b82dc54..92b1c85309 100644
--- a/doc/classes/File.xml
+++ b/doc/classes/File.xml
@@ -486,6 +486,7 @@
</argument>
<description>
Stores any Variant value in the file. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code).
+ [b]Note:[/b] Not all properties are included. Only properties that are configured with the [constant PROPERTY_USAGE_STORAGE] flag set will be serialized. You can add a new usage flag to a property by overriding the [method Object._get_property_list] method in your class. You can also check how property usage is configured by calling [method Object._get_property_list]. See [enum PropertyUsageFlags] for the possible usage flags.
</description>
</method>
</methods>