Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: def522830a
Branches Tags
godot-docs
/
classes
/
class_resourceinteractiveloader.rst

class_resourceinteractiveloader.rst 4.5 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the ResourceInteractiveLoader.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_ResourceInteractiveLoader:
    8. 

  8. 

  9. ResourceInteractiveLoader
    10. 

  10. =========================
    11. 

  11. 

  12. **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Category:** Core
    15. 

  15. 

  16. Brief Description
    17. 

  17. -----------------
    18. 

  18. 

  19. Interactive :ref:`Resource<class_Resource>` loader.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

  24. +---------------------------------------+--------------------------------------------------------------------------------------------------+
    25. 

  25. | :ref:`Resource<class_Resource>`       | :ref:`get_resource<class_ResourceInteractiveLoader_method_get_resource>` **(** **)**             |
    26. 

  26. +---------------------------------------+--------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`int<class_int>`                 | :ref:`get_stage<class_ResourceInteractiveLoader_method_get_stage>` **(** **)** const             |
    28. 

  28. +---------------------------------------+--------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`int<class_int>`                 | :ref:`get_stage_count<class_ResourceInteractiveLoader_method_get_stage_count>` **(** **)** const |
    30. 

  30. +---------------------------------------+--------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`poll<class_ResourceInteractiveLoader_method_poll>` **(** **)**                             |
    32. 

  32. +---------------------------------------+--------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`wait<class_ResourceInteractiveLoader_method_wait>` **(** **)**                             |
    34. 

  34. +---------------------------------------+--------------------------------------------------------------------------------------------------+
    35. 

  35. 

  36. Description
    37. 

  37. -----------
    38. 

  38. 

  39. 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.
    40. 

  40. 

  41. Method Descriptions
    42. 

  42. -------------------
    43. 

  43. 

  44. .. _class_ResourceInteractiveLoader_method_get_resource:
    45. 

  45. 

  46. - :ref:`Resource<class_Resource>` **get_resource** **(** **)**
    47. 

  47. 

  48. Returns the loaded resource if the load operation completed successfully, ``null`` otherwise.
    49. 

  49. 

  50. .. _class_ResourceInteractiveLoader_method_get_stage:
    51. 

  51. 

  52. - :ref:`int<class_int>` **get_stage** **(** **)** const
    53. 

  53. 

  54. Returns the load stage. The total amount of stages can be queried with :ref:`get_stage_count<class_ResourceInteractiveLoader_method_get_stage_count>`.
    55. 

  55. 

  56. .. _class_ResourceInteractiveLoader_method_get_stage_count:
    57. 

  57. 

  58. - :ref:`int<class_int>` **get_stage_count** **(** **)** const
    59. 

  59. 

  60. Returns the total amount of stages (calls to :ref:`poll<class_ResourceInteractiveLoader_method_poll>`) needed to completely load this resource.
    61. 

  61. 

  62. .. _class_ResourceInteractiveLoader_method_poll:
    63. 

  63. 

  64. - :ref:`Error<enum_@GlobalScope_Error>` **poll** **(** **)**
    65. 

  65. 

  66. Polls the loading operation, i.e. loads a data chunk up to the next stage.
    67. 

  67. 

  68. 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.
    69. 

  69. 

  70. 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>`.
    71. 

  71. 

  72. Returns another :ref:`Error<enum_@GlobalScope_Error>` code if the poll has failed.
    73. 

  73. 

  74. .. _class_ResourceInteractiveLoader_method_wait:
    75. 

  75. 

  76. - :ref:`Error<enum_@GlobalScope_Error>` **wait** **(** **)**
    77. 

  77. 

  78. Polls the loading operation successively until the resource is completely loaded or a :ref:`poll<class_ResourceInteractiveLoader_method_poll>` fails.
    79. 

  79. 

  80. 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>`.
    81. 

  81. 

  82. Returns another :ref:`Error<enum_@GlobalScope_Error>` code if a poll has failed, aborting the operation.
    83. 

  83.