class_resourcesaver.rst 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_ResourceSaver:
  4. ResourceSaver
  5. =============
  6. **Inherits:** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Resource Saving Interface.
  11. Member Functions
  12. ----------------
  13. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`StringArray<class_stringarray>` | :ref:`get_recognized_extensions<class_ResourceSaver_get_recognized_extensions>` **(** :ref:`Object<class_object>` type **)** |
  15. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`int<class_int>` | :ref:`save<class_ResourceSaver_save>` **(** :ref:`String<class_string>` path, :ref:`Resource<class_resource>` resource, :ref:`int<class_int>` flags=0 **)** |
  17. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. Numeric Constants
  19. -----------------
  20. - **FLAG_RELATIVE_PATHS** = **1**
  21. - **FLAG_BUNDLE_RESOURCES** = **2**
  22. - **FLAG_CHANGE_PATH** = **4**
  23. - **FLAG_OMIT_EDITOR_PROPERTIES** = **8**
  24. - **FLAG_SAVE_BIG_ENDIAN** = **16**
  25. - **FLAG_COMPRESS** = **32**
  26. Description
  27. -----------
  28. Resource Saving Interface. This interface is used for saving resources to disk.
  29. Member Function Description
  30. ---------------------------
  31. .. _class_ResourceSaver_get_recognized_extensions:
  32. - :ref:`StringArray<class_stringarray>` **get_recognized_extensions** **(** :ref:`Object<class_object>` type **)**
  33. Return the list of extensions available for saving a resource of a given type.
  34. .. _class_ResourceSaver_save:
  35. - :ref:`int<class_int>` **save** **(** :ref:`String<class_string>` path, :ref:`Resource<class_resource>` resource, :ref:`int<class_int>` flags=0 **)**
  36. Save a resource to disk, to a given path.