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

56 lines
2.3 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" ?>
doc: Update classref headers with 3.4 version
2021-04-26 11:14:51 +00:00
<class name="ResourceInteractiveLoader" inherits="Reference" version="3.4">
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>
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
Interactive [Resource] loader.
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>
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
Interactive [Resource] loader. This object is returned by [ResourceLoader] when performing an interactive load. It allows loading resources with high granularity, which makes it mainly useful for displaying loading bars or percentages.
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>
<method name="get_resource">
<return type="Resource">
</return>
<description>
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
Returns the loaded resource if the load operation completed successfully, [code]null[/code] otherwise.
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>
<method name="get_stage" qualifiers="const">
<return type="int">
</return>
<description>
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
Returns the load stage. The total amount of stages can be queried with [method get_stage_count].
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>
<method name="get_stage_count" qualifiers="const">
<return type="int">
</return>
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 02:15:43 +00:00
Returns the total amount of stages (calls to [method poll]) needed to completely load this 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>
</method>
<method name="poll">
<return type="int" enum="Error">
</return>
<description>
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
Polls the loading operation, i.e. loads a data chunk up to the next stage.
doc: Don't use `GlobalScope` scope in hyperlinks, it's automatically inferred
2019-06-27 11:24:03 +00:00
Returns [constant OK] if the poll is successful but the load operation has not finished yet (intermediate stage). This means [method poll] will have to be called again until the last stage is completed.
Returns [constant ERR_FILE_EOF] if the load operation has completed successfully. The loaded resource can be obtained by calling [method get_resource].
Returns another [enum Error] code if the poll has failed.
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>
<method name="wait">
<return type="int" enum="Error">
</return>
<description>
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
Polls the loading operation successively until the resource is completely loaded or a [method poll] fails.
doc: Don't use `GlobalScope` scope in hyperlinks, it's automatically inferred
2019-06-27 11:24:03 +00:00
Returns [constant ERR_FILE_EOF] if the load operation has completed successfully. The loaded resource can be obtained by calling [method get_resource].
Returns another [enum Error] code if a poll has failed, aborting the operation.
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>
</constants>
</class>