class_resourcesaver.rst 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the ResourceSaver.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_ResourceSaver:
  5. ResourceSaver
  6. =============
  7. **Inherits:** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Resource saving interface.
  12. Methods
  13. -------
  14. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_recognized_extensions<class_ResourceSaver_get_recognized_extensions>` **(** :ref:`Resource<class_Resource>` type **)** |
  16. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :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 **)** |
  18. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. Enumerations
  20. ------------
  21. .. _enum_ResourceSaver_SaverFlags:
  22. enum **SaverFlags**:
  23. - **FLAG_RELATIVE_PATHS** = **1**
  24. - **FLAG_BUNDLE_RESOURCES** = **2**
  25. - **FLAG_CHANGE_PATH** = **4**
  26. - **FLAG_OMIT_EDITOR_PROPERTIES** = **8**
  27. - **FLAG_SAVE_BIG_ENDIAN** = **16**
  28. - **FLAG_COMPRESS** = **32**
  29. - **FLAG_REPLACE_SUBRESOURCE_PATHS** = **64**
  30. Description
  31. -----------
  32. Resource saving interface, used for saving resources to disk.
  33. Method Descriptions
  34. -------------------
  35. .. _class_ResourceSaver_get_recognized_extensions:
  36. - :ref:`PoolStringArray<class_PoolStringArray>` **get_recognized_extensions** **(** :ref:`Resource<class_Resource>` type **)**
  37. Returns the list of extensions available for saving a resource of a given type.
  38. .. _class_ResourceSaver_save:
  39. - :ref:`Error<enum_@GlobalScope_Error>` **save** **(** :ref:`String<class_String>` path, :ref:`Resource<class_Resource>` resource, :ref:`int<class_int>` flags=0 **)**
  40. Saves a resource to disk.