:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ResourceInteractiveLoader.xml. .. _class_ResourceInteractiveLoader: ResourceInteractiveLoader ========================= **Inherits:** :ref:`Reference` **<** :ref:`Object` Interactive :ref:`Resource` loader. .. rst-class:: classref-introduction-group Description ----------- Interactive :ref:`Resource` loader. This object is returned by :ref:`ResourceLoader` when performing an interactive load. It allows loading resources with high granularity, which makes it mainly useful for displaying loading bars or percentages. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------+--------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`no_subresource_cache` | +-------------------------+--------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+----------------------------------------------------------------------------------------------------+ | :ref:`Resource` | :ref:`get_resource` **(** **)** | +---------------------------------------+----------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_stage` **(** **)** |const| | +---------------------------------------+----------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_stage_count` **(** **)** |const| | +---------------------------------------+----------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`poll` **(** **)** | +---------------------------------------+----------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`wait` **(** **)** | +---------------------------------------+----------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ResourceInteractiveLoader_property_no_subresource_cache: .. rst-class:: classref-property :ref:`bool` **no_subresource_cache** .. rst-class:: classref-property-setget - void **set_no_subresource_cache** **(** :ref:`bool` value **)** - :ref:`bool` **get_no_subresource_cache** **(** **)** Configures whether nested resources, if included, should not be cached. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ResourceInteractiveLoader_method_get_resource: .. rst-class:: classref-method :ref:`Resource` **get_resource** **(** **)** Returns the loaded resource if the load operation completed successfully, ``null`` otherwise. .. rst-class:: classref-item-separator ---- .. _class_ResourceInteractiveLoader_method_get_stage: .. rst-class:: classref-method :ref:`int` **get_stage** **(** **)** |const| Returns the load stage. The total amount of stages can be queried with :ref:`get_stage_count`. .. rst-class:: classref-item-separator ---- .. _class_ResourceInteractiveLoader_method_get_stage_count: .. rst-class:: classref-method :ref:`int` **get_stage_count** **(** **)** |const| Returns the total amount of stages (calls to :ref:`poll`) needed to completely load this resource. .. rst-class:: classref-item-separator ---- .. _class_ResourceInteractiveLoader_method_poll: .. rst-class:: classref-method :ref:`Error` **poll** **(** **)** Polls the loading operation, i.e. loads a data chunk up to the next stage. Returns :ref:`@GlobalScope.OK` if the poll is successful but the load operation has not finished yet (intermediate stage). This means :ref:`poll` will have to be called again until the last stage is completed. Returns :ref:`@GlobalScope.ERR_FILE_EOF` if the load operation has completed successfully. The loaded resource can be obtained by calling :ref:`get_resource`. Returns another :ref:`Error` code if the poll has failed. .. rst-class:: classref-item-separator ---- .. _class_ResourceInteractiveLoader_method_wait: .. rst-class:: classref-method :ref:`Error` **wait** **(** **)** Polls the loading operation successively until the resource is completely loaded or a :ref:`poll` fails. Returns :ref:`@GlobalScope.ERR_FILE_EOF` if the load operation has completed successfully. The loaded resource can be obtained by calling :ref:`get_resource`. Returns another :ref:`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.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`