Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 7a86ac6a30
Branches Tags
godot-docs
/
classes
/
class_resourceformatsaver.rst

class_resourceformatsaver.rst 4.3 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the ResourceFormatSaver.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_ResourceFormatSaver:
    8. 

  8. 

  9. ResourceFormatSaver
    10. 

  10. ===================
    11. 

  11. 

  12. **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. Saves a specific resource type to a file.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. The engine can save resources when you do it from the editor, or when you use the :ref:`ResourceSaver<class_ResourceSaver>` singleton. This is accomplished thanks to multiple ``ResourceFormatSaver``\ s, each handling its own format and called automatically by the engine.
    20. 

  20. 

  21. By default, Godot saves resources as ``.tres`` (text-based), ``.res`` (binary) or another built-in format, but you can choose to create your own format by extending this class. Be sure to respect the documented return types and values. You should give it a global class name with ``class_name`` for it to be registered. Like built-in ResourceFormatSavers, it will be called automatically when saving resources of its recognized type(s). You may also implement a :ref:`ResourceFormatLoader<class_ResourceFormatLoader>`.
    22. 

  22. 

  23. Methods
    24. 

  24. -------
    25. 

  25. 

  26. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_recognized_extensions<class_ResourceFormatSaver_method_get_recognized_extensions>` **(** :ref:`Resource<class_Resource>` resource **)** |virtual|                      |
    28. 

  28. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`bool<class_bool>`                       | :ref:`recognize<class_ResourceFormatSaver_method_recognize>` **(** :ref:`Resource<class_Resource>` resource **)** |virtual|                                                      |
    30. 

  30. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`int<class_int>`                         | :ref:`save<class_ResourceFormatSaver_method_save>` **(** :ref:`String<class_String>` path, :ref:`Resource<class_Resource>` resource, :ref:`int<class_int>` flags **)** |virtual| |
    32. 

  32. +-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. 

  34. Method Descriptions
    35. 

  35. -------------------
    36. 

  36. 

  37. .. _class_ResourceFormatSaver_method_get_recognized_extensions:
    38. 

  38. 

  39. - :ref:`PoolStringArray<class_PoolStringArray>` **get_recognized_extensions** **(** :ref:`Resource<class_Resource>` resource **)** |virtual|
    40. 

  40. 

  41. Returns the list of extensions available for saving the resource object, provided it is recognized (see :ref:`recognize<class_ResourceFormatSaver_method_recognize>`).
    42. 

  42. 

  43. ----
    44. 

  44. 

  45. .. _class_ResourceFormatSaver_method_recognize:
    46. 

  46. 

  47. - :ref:`bool<class_bool>` **recognize** **(** :ref:`Resource<class_Resource>` resource **)** |virtual|
    48. 

  48. 

  49. Returns whether the given resource object can be saved by this saver.
    50. 

  50. 

  51. ----
    52. 

  52. 

  53. .. _class_ResourceFormatSaver_method_save:
    54. 

  54. 

  55. - :ref:`int<class_int>` **save** **(** :ref:`String<class_String>` path, :ref:`Resource<class_Resource>` resource, :ref:`int<class_int>` flags **)** |virtual|
    56. 

  56. 

  57. Saves the given resource object to a file at the target ``path``. ``flags`` is a bitmask composed with :ref:`SaverFlags<enum_ResourceSaver_SaverFlags>` constants.
    58. 

  58. 

  59. Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success, or an :ref:`Error<enum_@GlobalScope_Error>` constant in case of failure.
    60. 

  60. 

  61. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    62. 

  62. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    63. 

  63. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    64. 

  64.