mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
223 lines
16 KiB
ReStructuredText
223 lines
16 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the ResourceLoader.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_ResourceLoader:
|
|
|
|
ResourceLoader
|
|
==============
|
|
|
|
**Inherits:** :ref:`Object<class_Object>`
|
|
|
|
Singleton used to load resource files.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Singleton used to load resource files from the filesystem.
|
|
|
|
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.
|
|
|
|
\ **Note:** You have to import the files into the engine first to load them using :ref:`load<class_ResourceLoader_method_load>`. If you want to load :ref:`Image<class_Image>`\ s at run-time, you may use :ref:`Image.load<class_Image_method_load>`. If you want to import audio files, you can use the snippet described in :ref:`AudioStreamMP3.data<class_AudioStreamMP3_property_data>`.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`__
|
|
|
|
Methods
|
|
-------
|
|
|
|
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_resource_format_loader<class_ResourceLoader_method_add_resource_format_loader>` **(** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` format_loader, :ref:`bool<class_bool>` at_front=false **)** |
|
|
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`exists<class_ResourceLoader_method_exists>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="" **)** |
|
|
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_dependencies<class_ResourceLoader_method_get_dependencies>` **(** :ref:`String<class_String>` path **)** |
|
|
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_recognized_extensions_for_type<class_ResourceLoader_method_get_recognized_extensions_for_type>` **(** :ref:`String<class_String>` type **)** |
|
|
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_resource_uid<class_ResourceLoader_method_get_resource_uid>` **(** :ref:`String<class_String>` path **)** |
|
|
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`has_cached<class_ResourceLoader_method_has_cached>` **(** :ref:`String<class_String>` path **)** |
|
|
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Resource<class_Resource>` | :ref:`load<class_ResourceLoader_method_load>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="", :ref:`CacheMode<enum_ResourceLoader_CacheMode>` cache_mode=1 **)** |
|
|
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Resource<class_Resource>` | :ref:`load_threaded_get<class_ResourceLoader_method_load_threaded_get>` **(** :ref:`String<class_String>` path **)** |
|
|
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :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=[] **)** |
|
|
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :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 **)** |
|
|
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`remove_resource_format_loader<class_ResourceLoader_method_remove_resource_format_loader>` **(** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` format_loader **)** |
|
|
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_abort_on_missing_resources<class_ResourceLoader_method_set_abort_on_missing_resources>` **(** :ref:`bool<class_bool>` abort **)** |
|
|
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_ResourceLoader_ThreadLoadStatus:
|
|
|
|
.. _class_ResourceLoader_constant_THREAD_LOAD_INVALID_RESOURCE:
|
|
|
|
.. _class_ResourceLoader_constant_THREAD_LOAD_IN_PROGRESS:
|
|
|
|
.. _class_ResourceLoader_constant_THREAD_LOAD_FAILED:
|
|
|
|
.. _class_ResourceLoader_constant_THREAD_LOAD_LOADED:
|
|
|
|
enum **ThreadLoadStatus**:
|
|
|
|
- **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>`.
|
|
|
|
- **THREAD_LOAD_IN_PROGRESS** = **1** --- The resource is still being loaded.
|
|
|
|
- **THREAD_LOAD_FAILED** = **2** --- Some error occurred during loading and it failed.
|
|
|
|
- **THREAD_LOAD_LOADED** = **3** --- The resource was loaded successfully and can be accessed via :ref:`load_threaded_get<class_ResourceLoader_method_load_threaded_get>`.
|
|
|
|
----
|
|
|
|
.. _enum_ResourceLoader_CacheMode:
|
|
|
|
.. _class_ResourceLoader_constant_CACHE_MODE_IGNORE:
|
|
|
|
.. _class_ResourceLoader_constant_CACHE_MODE_REUSE:
|
|
|
|
.. _class_ResourceLoader_constant_CACHE_MODE_REPLACE:
|
|
|
|
enum **CacheMode**:
|
|
|
|
- **CACHE_MODE_IGNORE** = **0**
|
|
|
|
- **CACHE_MODE_REUSE** = **1**
|
|
|
|
- **CACHE_MODE_REPLACE** = **2**
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_ResourceLoader_method_add_resource_format_loader:
|
|
|
|
- void **add_resource_format_loader** **(** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` format_loader, :ref:`bool<class_bool>` at_front=false **)**
|
|
|
|
Registers a new :ref:`ResourceFormatLoader<class_ResourceFormatLoader>`. The ResourceLoader will use the ResourceFormatLoader as described in :ref:`load<class_ResourceLoader_method_load>`.
|
|
|
|
This method is performed implicitly for ResourceFormatLoaders written in GDScript (see :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` for more information).
|
|
|
|
----
|
|
|
|
.. _class_ResourceLoader_method_exists:
|
|
|
|
- :ref:`bool<class_bool>` **exists** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="" **)**
|
|
|
|
Returns whether a recognized resource exists for the given ``path``.
|
|
|
|
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>`. Anything that inherits from :ref:`Resource<class_Resource>` can be used as a type hint, for example :ref:`Image<class_Image>`.
|
|
|
|
----
|
|
|
|
.. _class_ResourceLoader_method_get_dependencies:
|
|
|
|
- :ref:`PackedStringArray<class_PackedStringArray>` **get_dependencies** **(** :ref:`String<class_String>` path **)**
|
|
|
|
Returns the dependencies for the resource at the given ``path``.
|
|
|
|
----
|
|
|
|
.. _class_ResourceLoader_method_get_recognized_extensions_for_type:
|
|
|
|
- :ref:`PackedStringArray<class_PackedStringArray>` **get_recognized_extensions_for_type** **(** :ref:`String<class_String>` type **)**
|
|
|
|
Returns the list of recognized extensions for a resource type.
|
|
|
|
----
|
|
|
|
.. _class_ResourceLoader_method_get_resource_uid:
|
|
|
|
- :ref:`int<class_int>` **get_resource_uid** **(** :ref:`String<class_String>` path **)**
|
|
|
|
Returns the ID associated with a given resource path, or ``-1`` when no such ID exists.
|
|
|
|
----
|
|
|
|
.. _class_ResourceLoader_method_has_cached:
|
|
|
|
- :ref:`bool<class_bool>` **has_cached** **(** :ref:`String<class_String>` path **)**
|
|
|
|
Returns whether a cached resource is available for the given ``path``.
|
|
|
|
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.
|
|
|
|
----
|
|
|
|
.. _class_ResourceLoader_method_load:
|
|
|
|
- :ref:`Resource<class_Resource>` **load** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="", :ref:`CacheMode<enum_ResourceLoader_CacheMode>` cache_mode=1 **)**
|
|
|
|
Loads a resource at the given ``path``, caching the result for further access.
|
|
|
|
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.
|
|
|
|
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>`. Anything that inherits from :ref:`Resource<class_Resource>` can be used as a type hint, for example :ref:`Image<class_Image>`.
|
|
|
|
The ``cache_mode`` property defines whether and how the cache should be used or updated when loading the resource. See :ref:`CacheMode<enum_ResourceLoader_CacheMode>` for details.
|
|
|
|
Returns an empty resource if no :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` could handle the file.
|
|
|
|
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.
|
|
|
|
----
|
|
|
|
.. _class_ResourceLoader_method_load_threaded_get:
|
|
|
|
- :ref:`Resource<class_Resource>` **load_threaded_get** **(** :ref:`String<class_String>` path **)**
|
|
|
|
Returns the resource loaded by :ref:`load_threaded_request<class_ResourceLoader_method_load_threaded_request>`.
|
|
|
|
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.
|
|
|
|
----
|
|
|
|
.. _class_ResourceLoader_method_load_threaded_get_status:
|
|
|
|
- :ref:`ThreadLoadStatus<enum_ResourceLoader_ThreadLoadStatus>` **load_threaded_get_status** **(** :ref:`String<class_String>` path, :ref:`Array<class_Array>` progress=[] **)**
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
----
|
|
|
|
.. _class_ResourceLoader_method_load_threaded_request:
|
|
|
|
- :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 **)**
|
|
|
|
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).
|
|
|
|
----
|
|
|
|
.. _class_ResourceLoader_method_remove_resource_format_loader:
|
|
|
|
- void **remove_resource_format_loader** **(** :ref:`ResourceFormatLoader<class_ResourceFormatLoader>` format_loader **)**
|
|
|
|
Unregisters the given :ref:`ResourceFormatLoader<class_ResourceFormatLoader>`.
|
|
|
|
----
|
|
|
|
.. _class_ResourceLoader_method_set_abort_on_missing_resources:
|
|
|
|
- void **set_abort_on_missing_resources** **(** :ref:`bool<class_bool>` abort **)**
|
|
|
|
Changes the behavior on missing sub-resources. The default behavior is to abort loading.
|
|
|
|
.. |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.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|