godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/ResourceSaver.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

75 lines
3.7 KiB
XML
Raw Normal View History

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.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="ResourceSaver" inherits="Object" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
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.
2017-09-12 20:42:36 +00:00
<brief_description>
Overhaul the top sections of the class reference (Core classes) (cherry picked from commit 04562662d38a83e1ac1fde2af9572ca38147e772)
2023-04-27 23:35:33 +00:00
A singleton for saving [Resource]s to the filesystem.
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.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Overhaul the top sections of the class reference (Core classes) (cherry picked from commit 04562662d38a83e1ac1fde2af9572ca38147e772)
2023-04-27 23:35:33 +00:00
A singleton for saving resource types to the filesystem.
It uses the many [ResourceFormatSaver] classes registered in the engine (either built-in or from a plugin) to save resource data to text-based (e.g. [code].tres[/code] or [code].tscn[/code]) or binary files (e.g. [code].res[/code] or [code].scn[/code]).
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.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
Exposes methods for adding and removing ResourceFormatLoaders and -Savers in the ClassDB
2022-05-15 13:42:27 +00:00
<method name="add_resource_format_saver">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="format_saver" type="ResourceFormatSaver" />
<param index="1" name="at_front" type="bool" default="false" />
Exposes methods for adding and removing ResourceFormatLoaders and -Savers in the ClassDB
2022-05-15 13:42:27 +00:00
<description>
Registers a new [ResourceFormatSaver]. The ResourceSaver will use the ResourceFormatSaver as described in [method save].
Fix various typos not caught by codespell Revert upstream `core/input/gamecontrollerdb.txt`. Upstream fix: https://github.com/gabomdq/SDL_GameControllerDB/pull/600
2022-07-21 11:37:00 +00:00
This method is performed implicitly for ResourceFormatSavers written in GDScript (see [ResourceFormatSaver] for more information).
Exposes methods for adding and removing ResourceFormatLoaders and -Savers in the ClassDB
2022-05-15 13:42:27 +00:00
</description>
</method>
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.
2017-09-12 20:42:36 +00:00
<method name="get_recognized_extensions">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="type" type="Resource" />
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.
2017-09-12 20:42:36 +00:00
<description>
[DOCS] Classref additions and corrections
2018-09-01 18:07:51 +00:00
Returns the list of extensions available for saving a resource of a given type.
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
Exposes methods for adding and removing ResourceFormatLoaders and -Savers in the ClassDB
2022-05-15 13:42:27 +00:00
<method name="remove_resource_format_saver">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="format_saver" type="ResourceFormatSaver" />
Exposes methods for adding and removing ResourceFormatLoaders and -Savers in the ClassDB
2022-05-15 13:42:27 +00:00
<description>
Unregisters the given [ResourceFormatSaver].
</description>
</method>
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.
2017-09-12 20:42:36 +00:00
<method name="save">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="Error" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="resource" type="Resource" />
<param index="1" name="path" type="String" default="&quot;&quot;" />
<param index="2" name="flags" type="int" enum="ResourceSaver.SaverFlags" default="0" />
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.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 02:00:19 +00:00
Saves a resource to disk to the given path, using a [ResourceFormatSaver] that recognizes the resource object. If [param path] is empty, [ResourceSaver] will try to use [member Resource.resource_path].
The [param flags] bitmask can be specified to customize the save behavior using [enum SaverFlags] flags.
doc: Don't use `GlobalScope` scope in hyperlinks, it's automatically inferred
2019-06-27 11:24:03 +00:00
Returns [constant OK] on success.
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<constants>
Implement a BitField hint Allows to specify the binder that an enum must be treated as a bitfield.
2022-06-24 09:16:37 +00:00
<constant name="FLAG_NONE" value="0" enum="SaverFlags" is_bitfield="true">
Fix ResourceSaver::save method exposition flag parameter enh: Add FLAG_NONE to SaverFlags in ResourceSaver to fix api inconsistency fix: flags parameter of ResourceSaver::save is now uint32_t to allow flag composition in scripts
2022-02-10 19:11:40 +00:00
No resource saving option.
</constant>
Implement a BitField hint Allows to specify the binder that an enum must be treated as a bitfield.
2022-06-24 09:16:37 +00:00
<constant name="FLAG_RELATIVE_PATHS" value="1" enum="SaverFlags" is_bitfield="true">
doc: Improve docs for Resource* classes Also move module-specific classes to their own module's `doc_classes` folder.
2019-06-18 16:04:29 +00:00
Save the resource with a path relative to the scene which uses it.
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.
2017-09-12 20:42:36 +00:00
</constant>
Implement a BitField hint Allows to specify the binder that an enum must be treated as a bitfield.
2022-06-24 09:16:37 +00:00
<constant name="FLAG_BUNDLE_RESOURCES" value="2" enum="SaverFlags" is_bitfield="true">
doc: Improve docs for Resource* classes Also move module-specific classes to their own module's `doc_classes` folder.
2019-06-18 16:04:29 +00:00
Bundles external resources.
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.
2017-09-12 20:42:36 +00:00
</constant>
Implement a BitField hint Allows to specify the binder that an enum must be treated as a bitfield.
2022-06-24 09:16:37 +00:00
<constant name="FLAG_CHANGE_PATH" value="4" enum="SaverFlags" is_bitfield="true">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Changes the [member Resource.resource_path] of the saved resource to match its new location.
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.
2017-09-12 20:42:36 +00:00
</constant>
Implement a BitField hint Allows to specify the binder that an enum must be treated as a bitfield.
2022-06-24 09:16:37 +00:00
<constant name="FLAG_OMIT_EDITOR_PROPERTIES" value="8" enum="SaverFlags" is_bitfield="true">
doc: Improve docs for Resource* classes Also move module-specific classes to their own module's `doc_classes` folder.
2019-06-18 16:04:29 +00:00
Do not save editor-specific metadata (identified by their [code]__editor[/code] prefix).
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.
2017-09-12 20:42:36 +00:00
</constant>
Implement a BitField hint Allows to specify the binder that an enum must be treated as a bitfield.
2022-06-24 09:16:37 +00:00
<constant name="FLAG_SAVE_BIG_ENDIAN" value="16" enum="SaverFlags" is_bitfield="true">
Replace File/Directory with FileAccess/DirAccess
2022-09-05 11:01:31 +00:00
Save as big endian (see [member FileAccess.big_endian]).
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.
2017-09-12 20:42:36 +00:00
</constant>
Implement a BitField hint Allows to specify the binder that an enum must be treated as a bitfield.
2022-06-24 09:16:37 +00:00
<constant name="FLAG_COMPRESS" value="32" enum="SaverFlags" is_bitfield="true">
Replace File/Directory with FileAccess/DirAccess
2022-09-05 11:01:31 +00:00
Compress the resource on save using [constant FileAccess.COMPRESSION_ZSTD]. Only available for binary resource types.
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.
2017-09-12 20:42:36 +00:00
</constant>
Implement a BitField hint Allows to specify the binder that an enum must be treated as a bitfield.
2022-06-24 09:16:37 +00:00
<constant name="FLAG_REPLACE_SUBRESOURCE_PATHS" value="64" enum="SaverFlags" is_bitfield="true">
doc: Improve docs for Resource* classes Also move module-specific classes to their own module's `doc_classes` folder.
2019-06-18 16:04:29 +00:00
Take over the paths of the saved subresources (see [method Resource.take_over_path]).
doc: Sync with current source
2018-10-25 13:14:36 +00:00
</constant>
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.
2017-09-12 20:42:36 +00:00
</constants>
</class>