class_resourcesaver.rst 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  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. Member Functions
  13. ----------------
  14. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_recognized_extensions<class_ResourceSaver_get_recognized_extensions>` **(** :ref:`Resource<class_resource>` type **)** |
  16. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :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 **)** |
  18. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. Enums
  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. Description
  30. -----------
  31. Resource Saving Interface. This interface is used for saving resources to disk.
  32. Member Function Description
  33. ---------------------------
  34. .. _class_ResourceSaver_get_recognized_extensions:
  35. - :ref:`PoolStringArray<class_poolstringarray>` **get_recognized_extensions** **(** :ref:`Resource<class_resource>` type **)**
  36. Return the list of extensions available for saving a resource of a given type.
  37. .. _class_ResourceSaver_save:
  38. - :ref:`int<class_int>` **save** **(** :ref:`String<class_string>` path, :ref:`Resource<class_resource>` resource, :ref:`int<class_int>` flags=0 **)**
  39. Save a resource to disk, to a given path.