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: Sync classref with current source
2019-07-05 09:32:53 +00:00
<class name="ResourceInteractiveLoader" inherits="Reference" category="Core" version="3.1.2">
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. (cherry picked from commit 0764451dc59690e158846b376f00eb8d889036f1)
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>
doc: Improve docs for Resource* classes Also move module-specific classes to their own module's `doc_classes` folder. (cherry picked from commit 0764451dc59690e158846b376f00eb8d889036f1)
2019-06-18 16:04:29 +00:00
Interactive [Resource] loader. This object is returned by [ResourceLoader] when performing an interactive load. It allows to load with high granularity, so this is mainly useful for displaying loading bars/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. (cherry picked from commit 0764451dc59690e158846b376f00eb8d889036f1)
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. (cherry picked from commit 0764451dc59690e158846b376f00eb8d889036f1)
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 (cherry picked from commit 426bcc9941e98696c872b0f6421d2ef28b987e60)
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. (cherry picked from commit 0764451dc59690e158846b376f00eb8d889036f1)
2019-06-18 16:04:29 +00:00
Polls the loading operation, i.e. loads a data chunk up to the next stage.
Returns [constant @GlobalScope.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 @GlobalScope.ERR_FILE_EOF] if the load operation has completed successfully. The loaded resource can be obtained by calling [method get_resource].
Returns another [enum @GlobalScope.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. (cherry picked from commit 0764451dc59690e158846b376f00eb8d889036f1)
2019-06-18 16:04:29 +00:00
Polls the loading operation successively until the resource is completely loaded or a [method poll] fails.
Returns [constant @GlobalScope.ERR_FILE_EOF] if the load operation has completed successfully. The loaded resource can be obtained by calling [method get_resource].
Returns another [enum @GlobalScope.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>