mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
92 lines
4.5 KiB
ReStructuredText
92 lines
4.5 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ResourceSaver.xml.
|
|
|
|
.. _class_ResourceSaver:
|
|
|
|
ResourceSaver
|
|
=============
|
|
|
|
**Inherits:** :ref:`Object<class_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<class_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
|
|
-------
|
|
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :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:`SaverFlags<enum_ResourceSaver_SaverFlags>` 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** --- 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<class_Resource_property_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.endian_swap<class_File_property_endian_swap>`).
|
|
|
|
- **FLAG_COMPRESS** = **32** --- Compress the resource on save using :ref:`File.COMPRESSION_ZSTD<class_File_constant_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<class_Resource_method_take_over_path>`).
|
|
|
|
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:`SaverFlags<enum_ResourceSaver_SaverFlags>` flags=0 **)**
|
|
|
|
Saves a resource to disk to the given path, using a :ref:`ResourceFormatSaver<class_ResourceFormatSaver>` that recognizes the resource object.
|
|
|
|
The ``flags`` bitmask can be specified to customize the save behavior.
|
|
|
|
Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_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.)`
|