mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
70 lines
3.5 KiB
ReStructuredText
70 lines
3.5 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the ResourceInteractiveLoader.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_ResourceInteractiveLoader:
|
|
|
|
ResourceInteractiveLoader
|
|
=========================
|
|
|
|
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Interactive Resource Loader.
|
|
|
|
Methods
|
|
-------
|
|
|
|
+---------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
| :ref:`Resource<class_Resource>` | :ref:`get_resource<class_ResourceInteractiveLoader_method_get_resource>` **(** **)** |
|
|
+---------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_stage<class_ResourceInteractiveLoader_method_get_stage>` **(** **)** const |
|
|
+---------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_stage_count<class_ResourceInteractiveLoader_method_get_stage_count>` **(** **)** const |
|
|
+---------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`poll<class_ResourceInteractiveLoader_method_poll>` **(** **)** |
|
|
+---------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`wait<class_ResourceInteractiveLoader_method_wait>` **(** **)** |
|
|
+---------------------------------------+--------------------------------------------------------------------------------------------------+
|
|
|
|
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.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_ResourceInteractiveLoader_method_get_resource:
|
|
|
|
- :ref:`Resource<class_Resource>` **get_resource** **(** **)**
|
|
|
|
Return the loaded resource (only if loaded). Otherwise, returns null.
|
|
|
|
.. _class_ResourceInteractiveLoader_method_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_method_get_stage_count>`
|
|
|
|
.. _class_ResourceInteractiveLoader_method_get_stage_count:
|
|
|
|
- :ref:`int<class_int>` **get_stage_count** **(** **)** const
|
|
|
|
Return the total amount of stages (calls to :ref:`poll<class_ResourceInteractiveLoader_method_poll>`) needed to completely load this resource.
|
|
|
|
.. _class_ResourceInteractiveLoader_method_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_method_get_resource>`.
|
|
|
|
.. _class_ResourceInteractiveLoader_method_wait:
|
|
|
|
- :ref:`Error<enum_@GlobalScope_Error>` **wait** **(** **)**
|
|
|