summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2021-06-29 13:59:17 +0200
committerGitHub <noreply@github.com>2021-06-29 13:59:17 +0200
commit76dc811c76cb7fa8f91d51d09d5013f918354570 (patch)
treefb9410bdcc132ed12a59e80e43470ccd520e453a
parent90982d60cbaca4112fea08f47c51b0837bcb0811 (diff)
parent2b7c0cfb344c3c430f52c4aeef1e05c83da62f91 (diff)
Merge pull request #49470 from levilindsey/master
Update File.store_var description to mention which properties of an object are included.
-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 7feaaa2040..f98c31dc7f 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>