godot-docs/classes/class_resourcesaver.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ResourceSaver.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_ResourceSaver:

ResourceSaver
=============

**Inherits:** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

Resource saving interface.

Methods
-------

+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_recognized_extensions<class_ResourceSaver_method_get_recognized_extensions>` **(** :ref:`Resource<class_Resource>` type **)**                            |
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`save<class_ResourceSaver_method_save>` **(** :ref:`String<class_String>` path, :ref:`Resource<class_Resource>` resource, :ref:`int<class_int>` flags=0 **)** |
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Enumerations
------------

.. _enum_ResourceSaver_SaverFlags:

.. _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:

enum **SaverFlags**:

- **FLAG_RELATIVE_PATHS** = **1**

- **FLAG_BUNDLE_RESOURCES** = **2**

- **FLAG_CHANGE_PATH** = **4**

- **FLAG_OMIT_EDITOR_PROPERTIES** = **8**

- **FLAG_SAVE_BIG_ENDIAN** = **16**

- **FLAG_COMPRESS** = **32**

- **FLAG_REPLACE_SUBRESOURCE_PATHS** = **64**

Description
-----------

Resource saving interface, used for saving resources to disk.

Method Descriptions
-------------------

.. _class_ResourceSaver_method_get_recognized_extensions:

- :ref:`PoolStringArray<class_PoolStringArray>` **get_recognized_extensions** **(** :ref:`Resource<class_Resource>` type **)**

Returns the list of extensions available for saving a resource of a given type.

.. _class_ResourceSaver_method_save:

- :ref:`Error<enum_@GlobalScope_Error>` **save** **(** :ref:`String<class_String>` path, :ref:`Resource<class_Resource>` resource, :ref:`int<class_int>` flags=0 **)**

Saves a resource to disk.