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

50 lines
1.6 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>
Interactive Resource Loader.
</brief_description>
<description>
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 load bars/percentages.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_resource">
<return type="Resource">
</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 loaded resource (only if loaded). Otherwise, returns null.
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>
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 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>
Poll the load. If OK is returned, this means poll will have to be called again. If ERR_FILE_EOF is returned, them the load has finished and the resource can be obtained by calling [method get_resource].
</description>
</method>
<method name="wait">
<return type="int" enum="Error">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>