Browse Source

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

(cherry picked from commit 2b7c0cfb344c3c430f52c4aeef1e05c83da62f91)
Levi Lindsey 4 years ago
parent
commit
f72ce41700
1 changed files with 1 additions and 0 deletions
  1. 1 0
      doc/classes/File.xml

+ 1 - 0
doc/classes/File.xml

@@ -450,6 +450,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>