| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.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>`
- Interactive :ref:`Resource<class_Resource>` loader.
- Description
- -----------
- Interactive :ref:`Resource<class_Resource>` loader. This object is returned by :ref:`ResourceLoader<class_ResourceLoader>` when performing an interactive load. It allows loading resources with high granularity, which makes it mainly useful for displaying loading bars or percentages.
- 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>` **(** **)** |
- +---------------------------------------+----------------------------------------------------------------------------------------------------+
- Method Descriptions
- -------------------
- .. _class_ResourceInteractiveLoader_method_get_resource:
- - :ref:`Resource<class_Resource>` **get_resource** **(** **)**
- Returns the loaded resource if the load operation completed successfully, ``null`` otherwise.
- ----
- .. _class_ResourceInteractiveLoader_method_get_stage:
- - :ref:`int<class_int>` **get_stage** **(** **)** |const|
- Returns 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|
- Returns 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** **(** **)**
- Polls the loading operation, i.e. loads a data chunk up to the next stage.
- Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if the poll is successful but the load operation has not finished yet (intermediate stage). This means :ref:`poll<class_ResourceInteractiveLoader_method_poll>` will have to be called again until the last stage is completed.
- Returns :ref:`@GlobalScope.ERR_FILE_EOF<class_@GlobalScope_constant_ERR_FILE_EOF>` if the load operation has completed successfully. The loaded resource can be obtained by calling :ref:`get_resource<class_ResourceInteractiveLoader_method_get_resource>`.
- Returns another :ref:`Error<enum_@GlobalScope_Error>` code if the poll has failed.
- ----
- .. _class_ResourceInteractiveLoader_method_wait:
- - :ref:`Error<enum_@GlobalScope_Error>` **wait** **(** **)**
- Polls the loading operation successively until the resource is completely loaded or a :ref:`poll<class_ResourceInteractiveLoader_method_poll>` fails.
- Returns :ref:`@GlobalScope.ERR_FILE_EOF<class_@GlobalScope_constant_ERR_FILE_EOF>` if the load operation has completed successfully. The loaded resource can be obtained by calling :ref:`get_resource<class_ResourceInteractiveLoader_method_get_resource>`.
- Returns another :ref:`Error<enum_@GlobalScope_Error>` code if a poll has failed, aborting the operation.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
