summaryrefslogtreecommitdiff
path: root/doc/classes/ResourceSaver.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/ResourceSaver.xml')
-rw-r--r--doc/classes/ResourceSaver.xml18
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml
index 240c72a131..b0c9056cbc 100644
--- a/doc/classes/ResourceSaver.xml
+++ b/doc/classes/ResourceSaver.xml
@@ -12,8 +12,8 @@
<methods>
<method name="add_resource_format_saver">
<return type="void" />
- <argument index="0" name="format_saver" type="ResourceFormatSaver" />
- <argument index="1" name="at_front" type="bool" default="false" />
+ <param index="0" name="format_saver" type="ResourceFormatSaver" />
+ <param index="1" name="at_front" type="bool" default="false" />
<description>
Registers a new [ResourceFormatSaver]. The ResourceSaver will use the ResourceFormatSaver as described in [method save].
This method is performed implicitly for ResourceFormatSavers written in GDScript (see [ResourceFormatSaver] for more information).
@@ -21,26 +21,26 @@
</method>
<method name="get_recognized_extensions">
<return type="PackedStringArray" />
- <argument index="0" name="type" type="Resource" />
+ <param index="0" name="type" type="Resource" />
<description>
Returns the list of extensions available for saving a resource of a given type.
</description>
</method>
<method name="remove_resource_format_saver">
<return type="void" />
- <argument index="0" name="format_saver" type="ResourceFormatSaver" />
+ <param index="0" name="format_saver" type="ResourceFormatSaver" />
<description>
Unregisters the given [ResourceFormatSaver].
</description>
</method>
<method name="save">
<return type="int" enum="Error" />
- <argument index="0" name="path" type="String" />
- <argument index="1" name="resource" type="Resource" />
- <argument index="2" name="flags" type="int" enum="ResourceSaver.SaverFlags" default="0" />
+ <param index="0" name="resource" type="Resource" />
+ <param index="1" name="path" type="String" default="&quot;&quot;" />
+ <param index="2" name="flags" type="int" enum="ResourceSaver.SaverFlags" default="0" />
<description>
- Saves a resource to disk to the given path, using a [ResourceFormatSaver] that recognizes the resource object.
- The [code]flags[/code] bitmask can be specified to customize the save behavior using [enum SaverFlags] flags.
+ Saves a resource to disk to the given path, using a [ResourceFormatSaver] that recognizes the resource object. If [param path] is empty, [ResourceSaver] will try to use [member Resource.resource_path].
+ The [param flags] bitmask can be specified to customize the save behavior using [enum SaverFlags] flags.
Returns [constant OK] on success.
</description>
</method>