Files
godot-docs/classes/class_resourcesaver.rst
2018-05-28 14:55:19 +02:00

64 lines
2.4 KiB
ReStructuredText

.. 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.
Member Functions
----------------
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_recognized_extensions<class_ResourceSaver_get_recognized_extensions>` **(** :ref:`Resource<class_resource>` type **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`save<class_ResourceSaver_save>` **(** :ref:`String<class_string>` path, :ref:`Resource<class_resource>` resource, :ref:`int<class_int>` flags=0 **)** |
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enums
-----
.. _enum_ResourceSaver_SaverFlags:
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**
Description
-----------
Resource Saving Interface. This interface is used for saving resources to disk.
Member Function Description
---------------------------
.. _class_ResourceSaver_get_recognized_extensions:
- :ref:`PoolStringArray<class_poolstringarray>` **get_recognized_extensions** **(** :ref:`Resource<class_resource>` type **)**
Return the list of extensions available for saving a resource of a given type.
.. _class_ResourceSaver_save:
- :ref:`Error<enum_@globalscope_error>` **save** **(** :ref:`String<class_string>` path, :ref:`Resource<class_resource>` resource, :ref:`int<class_int>` flags=0 **)**
Save a resource to disk, to a given path.