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: f26bdbbcd4
Branches Tags
godot-docs
/
classes
/
class_resourceloader.rst

class_resourceloader.rst 11 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159 
  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 ResourceLoader.xml source instead.
    5. 

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

  6. 

  7. .. _class_ResourceLoader:
    8. 

  8. 

  9. ResourceLoader
    10. 

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

  11. 

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

  13. 

  14. Singleton used to load resource files.
    15. 

  15. 

  16. Description
    17. 

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

  18. 

  19. Singleton used to load resource files from the filesystem.
    20. 

  20. 

  21. It uses the many :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` classes registered in the engine (either built-in or from a plugin) to load files into memory and convert them to a format that can be used by the engine.
    22. 

  22. 

  23. GDScript has a simplified :ref:`@GDScript.load<class_@GDScript_method_load>` built-in method which can be used in most situations, leaving the use of ``ResourceLoader`` for more advanced scenarios.
    24. 

  24. 

  25. Methods
    26. 

  26. -------
    27. 

  27. 

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

  29. | :ref:`bool<class_bool>`                                       | :ref:`exists<class_ResourceLoader_method_exists>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="" **)**                                                                              |
    30. 

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

  31. | :ref:`PackedStringArray<class_PackedStringArray>`             | :ref:`get_dependencies<class_ResourceLoader_method_get_dependencies>` **(** :ref:`String<class_String>` path **)**                                                                                                    |
    32. 

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

  33. | :ref:`PackedStringArray<class_PackedStringArray>`             | :ref:`get_recognized_extensions_for_type<class_ResourceLoader_method_get_recognized_extensions_for_type>` **(** :ref:`String<class_String>` type **)**                                                                |
    34. 

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

  35. | :ref:`bool<class_bool>`                                       | :ref:`has_cached<class_ResourceLoader_method_has_cached>` **(** :ref:`String<class_String>` path **)**                                                                                                                |
    36. 

  36. +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`Resource<class_Resource>`                               | :ref:`load<class_ResourceLoader_method_load>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="", :ref:`bool<class_bool>` no_cache=false **)**                                          |
    38. 

  38. +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`Resource<class_Resource>`                               | :ref:`load_threaded_get<class_ResourceLoader_method_load_threaded_get>` **(** :ref:`String<class_String>` path **)**                                                                                                  |
    40. 

  40. +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`ThreadLoadStatus<enum_ResourceLoader_ThreadLoadStatus>` | :ref:`load_threaded_get_status<class_ResourceLoader_method_load_threaded_get_status>` **(** :ref:`String<class_String>` path, :ref:`Array<class_Array>` progress=[  ] **)**                                           |
    42. 

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

  43. | :ref:`Error<enum_@GlobalScope_Error>`                         | :ref:`load_threaded_request<class_ResourceLoader_method_load_threaded_request>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="", :ref:`bool<class_bool>` use_sub_threads=false **)** |
    44. 

  44. +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | void                                                          | :ref:`set_abort_on_missing_resources<class_ResourceLoader_method_set_abort_on_missing_resources>` **(** :ref:`bool<class_bool>` abort **)**                                                                           |
    46. 

  46. +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. 

  48. Enumerations
    49. 

  49. ------------
    50. 

  50. 

  51. .. _enum_ResourceLoader_ThreadLoadStatus:
    52. 

  52. 

  53. .. _class_ResourceLoader_constant_THREAD_LOAD_INVALID_RESOURCE:
    54. 

  54. 

  55. .. _class_ResourceLoader_constant_THREAD_LOAD_IN_PROGRESS:
    56. 

  56. 

  57. .. _class_ResourceLoader_constant_THREAD_LOAD_FAILED:
    58. 

  58. 

  59. .. _class_ResourceLoader_constant_THREAD_LOAD_LOADED:
    60. 

  60. 

  61. enum **ThreadLoadStatus**:
    62. 

  62. 

  63. - **THREAD_LOAD_INVALID_RESOURCE** = **0** --- The resource is invalid, or has not been loaded with :ref:`load_threaded_request<class_ResourceLoader_method_load_threaded_request>`.
    64. 

  64. 

  65. - **THREAD_LOAD_IN_PROGRESS** = **1** --- The resource is still being loaded.
    66. 

  66. 

  67. - **THREAD_LOAD_FAILED** = **2** --- Some error occurred during loading and it failed.
    68. 

  68. 

  69. - **THREAD_LOAD_LOADED** = **3** --- The resource was loaded successfully and can be accessed via :ref:`load_threaded_get<class_ResourceLoader_method_load_threaded_get>`.
    70. 

  70. 

  71. Method Descriptions
    72. 

  72. -------------------
    73. 

  73. 

  74. .. _class_ResourceLoader_method_exists:
    75. 

  75. 

  76. - :ref:`bool<class_bool>` **exists** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="" **)**
    77. 

  77. 

  78. Returns whether a recognized resource exists for the given ``path``.
    79. 

  79. 

  80. An optional ``type_hint`` can be used to further specify the :ref:`Resource<class_Resource>` type that should be handled by the :ref:`ResourceFormatLoader<class_ResourceFormatLoader>`.
    81. 

  81. 

  82. ----
    83. 

  83. 

  84. .. _class_ResourceLoader_method_get_dependencies:
    85. 

  85. 

  86. - :ref:`PackedStringArray<class_PackedStringArray>` **get_dependencies** **(** :ref:`String<class_String>` path **)**
    87. 

  87. 

  88. Returns the dependencies for the resource at the given ``path``.
    89. 

  89. 

  90. ----
    91. 

  91. 

  92. .. _class_ResourceLoader_method_get_recognized_extensions_for_type:
    93. 

  93. 

  94. - :ref:`PackedStringArray<class_PackedStringArray>` **get_recognized_extensions_for_type** **(** :ref:`String<class_String>` type **)**
    95. 

  95. 

  96. Returns the list of recognized extensions for a resource type.
    97. 

  97. 

  98. ----
    99. 

  99. 

  100. .. _class_ResourceLoader_method_has_cached:
    101. 

  101. 

  102. - :ref:`bool<class_bool>` **has_cached** **(** :ref:`String<class_String>` path **)**
    103. 

  103. 

  104. Returns whether a cached resource is available for the given ``path``.
    105. 

  105. 

  106. Once a resource has been loaded by the engine, it is cached in memory for faster access, and future calls to the :ref:`load<class_ResourceLoader_method_load>` method will use the cached version. The cached resource can be overridden by using :ref:`Resource.take_over_path<class_Resource_method_take_over_path>` on a new resource for that same path.
    107. 

  107. 

  108. ----
    109. 

  109. 

  110. .. _class_ResourceLoader_method_load:
    111. 

  111. 

  112. - :ref:`Resource<class_Resource>` **load** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="", :ref:`bool<class_bool>` no_cache=false **)**
    113. 

  113. 

  114. Loads a resource at the given ``path``, caching the result for further access.
    115. 

  115. 

  116. The registered :ref:`ResourceFormatLoader<class_ResourceFormatLoader>`\ s are queried sequentially to find the first one which can handle the file's extension, and then attempt loading. If loading fails, the remaining ResourceFormatLoaders are also attempted.
    117. 

  117. 

  118. An optional ``type_hint`` can be used to further specify the :ref:`Resource<class_Resource>` type that should be handled by the :ref:`ResourceFormatLoader<class_ResourceFormatLoader>`.
    119. 

  119. 

  120. If ``no_cache`` is ``true``, the resource cache will be bypassed and the resource will be loaded anew. Otherwise, the cached resource will be returned if it exists.
    121. 

  121. 

  122. Returns an empty resource if no ResourceFormatLoader could handle the file.
    123. 

  123. 

  124. ----
    125. 

  125. 

  126. .. _class_ResourceLoader_method_load_threaded_get:
    127. 

  127. 

  128. - :ref:`Resource<class_Resource>` **load_threaded_get** **(** :ref:`String<class_String>` path **)**
    129. 

  129. 

  130. Returns the resource loaded by :ref:`load_threaded_request<class_ResourceLoader_method_load_threaded_request>`.
    131. 

  131. 

  132. If this is called before the loading thread is done (i.e. :ref:`load_threaded_get_status<class_ResourceLoader_method_load_threaded_get_status>` is not :ref:`THREAD_LOAD_LOADED<class_ResourceLoader_constant_THREAD_LOAD_LOADED>`), the calling thread will be blocked until the resource has finished loading.
    133. 

  133. 

  134. ----
    135. 

  135. 

  136. .. _class_ResourceLoader_method_load_threaded_get_status:
    137. 

  137. 

  138. - :ref:`ThreadLoadStatus<enum_ResourceLoader_ThreadLoadStatus>` **load_threaded_get_status** **(** :ref:`String<class_String>` path, :ref:`Array<class_Array>` progress=[  ] **)**
    139. 

  139. 

  140. Returns the status of a threaded loading operation started with :ref:`load_threaded_request<class_ResourceLoader_method_load_threaded_request>` for the resource at ``path``. See :ref:`ThreadLoadStatus<enum_ResourceLoader_ThreadLoadStatus>` for possible return values.
    141. 

  141. 

  142. An array variable can optionally be passed via ``progress``, and will return a one-element array containing the percentage of completion of the threaded loading.
    143. 

  143. 

  144. ----
    145. 

  145. 

  146. .. _class_ResourceLoader_method_load_threaded_request:
    147. 

  147. 

  148. - :ref:`Error<enum_@GlobalScope_Error>` **load_threaded_request** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="", :ref:`bool<class_bool>` use_sub_threads=false **)**
    149. 

  149. 

  150. Loads the resource using threads. If ``use_sub_threads`` is ``true``, multiple threads will be used to load the resource, which makes loading faster, but may affect the main thread (and thus cause game slowdowns).
    151. 

  151. 

  152. ----
    153. 

  153. 

  154. .. _class_ResourceLoader_method_set_abort_on_missing_resources:
    155. 

  155. 

  156. - void **set_abort_on_missing_resources** **(** :ref:`bool<class_bool>` abort **)**
    157. 

  157. 

  158. Changes the behavior on missing sub-resources. The default behavior is to abort loading.
    159. 

  159.