:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ResourceSaver.xml. .. _class_ResourceSaver: ResourceSaver ============= **Inherits:** :ref:`Object` Singleton for saving Godot-specific resource types. Description ----------- Singleton for saving Godot-specific resource types to the filesystem. It uses the many :ref:`ResourceFormatSaver` classes registered in the engine (either built-in or from a plugin) to save engine-specific resource data to text-based (e.g. ``.tres`` or ``.tscn``) or binary files (e.g. ``.res`` or ``.scn``). Methods ------- +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_resource_format_saver` **(** :ref:`ResourceFormatSaver` format_saver, :ref:`bool` at_front=false **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_resource_format_saver` **(** :ref:`ResourceFormatSaver` format_saver **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`SaverFlags` flags=0 **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_ResourceSaver_SaverFlags: .. _class_ResourceSaver_constant_FLAG_NONE: .. _class_ResourceSaver_constant_FLAG_RELATIVE_PATHS: .. _class_ResourceSaver_constant_FLAG_BUNDLE_RESOURCES: .. _class_ResourceSaver_constant_FLAG_CHANGE_PATH: .. _class_ResourceSaver_constant_FLAG_OMIT_EDITOR_PROPERTIES: .. _class_ResourceSaver_constant_FLAG_SAVE_BIG_ENDIAN: .. _class_ResourceSaver_constant_FLAG_COMPRESS: .. _class_ResourceSaver_constant_FLAG_REPLACE_SUBRESOURCE_PATHS: flags **SaverFlags**: - **FLAG_NONE** = **0** --- No resource saving option. - **FLAG_RELATIVE_PATHS** = **1** --- Save the resource with a path relative to the scene which uses it. - **FLAG_BUNDLE_RESOURCES** = **2** --- Bundles external resources. - **FLAG_CHANGE_PATH** = **4** --- Changes the :ref:`Resource.resource_path` of the saved resource to match its new location. - **FLAG_OMIT_EDITOR_PROPERTIES** = **8** --- Do not save editor-specific metadata (identified by their ``__editor`` prefix). - **FLAG_SAVE_BIG_ENDIAN** = **16** --- Save as big endian (see :ref:`File.big_endian`). - **FLAG_COMPRESS** = **32** --- Compress the resource on save using :ref:`File.COMPRESSION_ZSTD`. Only available for binary resource types. - **FLAG_REPLACE_SUBRESOURCE_PATHS** = **64** --- Take over the paths of the saved subresources (see :ref:`Resource.take_over_path`). Method Descriptions ------------------- .. _class_ResourceSaver_method_add_resource_format_saver: - void **add_resource_format_saver** **(** :ref:`ResourceFormatSaver` format_saver, :ref:`bool` at_front=false **)** Registers a new :ref:`ResourceFormatSaver`. The ResourceSaver will use the ResourceFormatSaver as described in :ref:`save`. This method is performed implicitly for ResourceFormatSavers written in GDScript (see :ref:`ResourceFormatSaver` for more information). ---- .. _class_ResourceSaver_method_get_recognized_extensions: - :ref:`PackedStringArray` **get_recognized_extensions** **(** :ref:`Resource` type **)** Returns the list of extensions available for saving a resource of a given type. ---- .. _class_ResourceSaver_method_remove_resource_format_saver: - void **remove_resource_format_saver** **(** :ref:`ResourceFormatSaver` format_saver **)** Unregisters the given :ref:`ResourceFormatSaver`. ---- .. _class_ResourceSaver_method_save: - :ref:`Error` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`SaverFlags` flags=0 **)** Saves a resource to disk to the given path, using a :ref:`ResourceFormatSaver` that recognizes the resource object. The ``flags`` bitmask can be specified to customize the save behavior using :ref:`SaverFlags` flags. Returns :ref:`@GlobalScope.OK` on success. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`