mirror of
https://github.com/godotengine/godot.git
synced 2024-12-21 10:25:24 +08:00
7adf4cc9b5
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
56 lines
2.6 KiB
XML
56 lines
2.6 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="ResourceSaver" inherits="Object" version="4.0">
|
|
<brief_description>
|
|
Singleton for saving Godot-specific resource types.
|
|
</brief_description>
|
|
<description>
|
|
Singleton for saving Godot-specific resource types to the filesystem.
|
|
It uses the many [ResourceFormatSaver] classes registered in the engine (either built-in or from a plugin) to save engine-specific resource data to text-based (e.g. [code].tres[/code] or [code].tscn[/code]) or binary files (e.g. [code].res[/code] or [code].scn[/code]).
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_recognized_extensions">
|
|
<return type="PackedStringArray" />
|
|
<argument 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="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" />
|
|
<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.
|
|
Returns [constant OK] on success.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
<constant name="FLAG_RELATIVE_PATHS" value="1" enum="SaverFlags">
|
|
Save the resource with a path relative to the scene which uses it.
|
|
</constant>
|
|
<constant name="FLAG_BUNDLE_RESOURCES" value="2" enum="SaverFlags">
|
|
Bundles external resources.
|
|
</constant>
|
|
<constant name="FLAG_CHANGE_PATH" value="4" enum="SaverFlags">
|
|
Changes the [member Resource.resource_path] of the saved resource to match its new location.
|
|
</constant>
|
|
<constant name="FLAG_OMIT_EDITOR_PROPERTIES" value="8" enum="SaverFlags">
|
|
Do not save editor-specific metadata (identified by their [code]__editor[/code] prefix).
|
|
</constant>
|
|
<constant name="FLAG_SAVE_BIG_ENDIAN" value="16" enum="SaverFlags">
|
|
Save as big endian (see [member File.big_endian]).
|
|
</constant>
|
|
<constant name="FLAG_COMPRESS" value="32" enum="SaverFlags">
|
|
Compress the resource on save using [constant File.COMPRESSION_ZSTD]. Only available for binary resource types.
|
|
</constant>
|
|
<constant name="FLAG_REPLACE_SUBRESOURCE_PATHS" value="64" enum="SaverFlags">
|
|
Take over the paths of the saved subresources (see [method Resource.take_over_path]).
|
|
</constant>
|
|
</constants>
|
|
</class>
|