summaryrefslogtreecommitdiff
path: root/doc/classes/ResourceSaver.xml
diff options
context:
space:
mode:
authorJuan Linietsky <reduzio@gmail.com>2017-09-12 17:42:36 -0300
committerJuan Linietsky <reduzio@gmail.com>2017-09-12 17:45:41 -0300
commit4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch)
tree730471182cae00f2e47c7430db441d057383d29b /doc/classes/ResourceSaver.xml
parent175777596ec3521731665dd750fd7087793b10fc (diff)
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
recognize them.
Diffstat (limited to 'doc/classes/ResourceSaver.xml')
-rw-r--r--doc/classes/ResourceSaver.xml51
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml
new file mode 100644
index 0000000000..de296776ad
--- /dev/null
+++ b/doc/classes/ResourceSaver.xml
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="ResourceSaver" inherits="Object" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Resource Saving Interface.
+ </brief_description>
+ <description>
+ Resource Saving Interface. This interface is used for saving resources to disk.
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_recognized_extensions">
+ <return type="PoolStringArray">
+ </return>
+ <argument index="0" name="type" type="Resource">
+ </argument>
+ <description>
+ Return the list of extensions available for saving a resource of a given type.
+ </description>
+ </method>
+ <method name="save">
+ <return type="int" enum="Error">
+ </return>
+ <argument index="0" name="path" type="String">
+ </argument>
+ <argument index="1" name="resource" type="Resource">
+ </argument>
+ <argument index="2" name="flags" type="int" default="0">
+ </argument>
+ <description>
+ Save a resource to disk, to a given path.
+ </description>
+ </method>
+ </methods>
+ <constants>
+ <constant name="FLAG_RELATIVE_PATHS" value="1">
+ </constant>
+ <constant name="FLAG_BUNDLE_RESOURCES" value="2">
+ </constant>
+ <constant name="FLAG_CHANGE_PATH" value="4">
+ </constant>
+ <constant name="FLAG_OMIT_EDITOR_PROPERTIES" value="8">
+ </constant>
+ <constant name="FLAG_SAVE_BIG_ENDIAN" value="16">
+ </constant>
+ <constant name="FLAG_COMPRESS" value="32">
+ </constant>
+ </constants>
+</class>