godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Add property overview and setter/getter like in editor docs

Browse Source 
Output from godotengine/godot#22013.
Fixes #1729.
This commit is contained in:
Rémi Verschelde
2018-09-13 11:06:52 +02:00
parent f9caa4be29
commit ab3f908221
578 changed files with 33831 additions and 6706 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
classes/class_resourceinteractiveloader.rst
View File

@@ -8,6 +8,7 @@ ResourceInteractiveLoader
=========================
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
@@ -38,32 +39,31 @@ Interactive Resource Loader. This object is returned by ResourceLoader when perf
Method Descriptions
-------------------
.. _class_ResourceInteractiveLoader_get_resource:
.. _class_ResourceInteractiveLoader_get_resource:
- :ref:`Resource<class_Resource>` **get_resource** **(** **)**
Return the loaded resource (only if loaded). Otherwise, returns null.
.. _class_ResourceInteractiveLoader_get_stage:
.. _class_ResourceInteractiveLoader_get_stage:
- :ref:`int<class_int>` **get_stage** **(** **)** const
Return the load stage. The total amount of stages can be queried with :ref:`get_stage_count<class_ResourceInteractiveLoader_get_stage_count>`
.. _class_ResourceInteractiveLoader_get_stage_count:
.. _class_ResourceInteractiveLoader_get_stage_count:
- :ref:`int<class_int>` **get_stage_count** **(** **)** const
Return the total amount of stages (calls to :ref:`poll<class_ResourceInteractiveLoader_poll>`) needed to completely load this resource.
.. _class_ResourceInteractiveLoader_poll:
.. _class_ResourceInteractiveLoader_poll:
- :ref:`Error<enum_@GlobalScope_Error>` **poll** **(** **)**
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 :ref:`get_resource<class_ResourceInteractiveLoader_get_resource>`.
.. _class_ResourceInteractiveLoader_wait:
.. _class_ResourceInteractiveLoader_wait:
- :ref:`Error<enum_@GlobalScope_Error>` **wait** **(** **)**