Update File.store_var description to mention which properties of an object are included.

This commit is contained in:
Levi Lindsey 2021-06-15 20:00:19 -07:00
parent 58c1235111
commit 2b7c0cfb34

View file

@ -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>