Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
ResourceLoader¶
Inherits: Object
A singleton for loading resource files.
Description¶
A singleton used to load resource files from the filesystem.
It uses the many 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 load. If you want to load Images at run-time, you may use Image.load. If you want to import audio files, you can use the snippet described in AudioStreamMP3.data.
Tutorials¶
Methods¶
void |
add_resource_format_loader ( ResourceFormatLoader format_loader, bool at_front=false ) |
get_dependencies ( String path ) |
|
get_recognized_extensions_for_type ( String type ) |
|
get_resource_uid ( String path ) |
|
has_cached ( String path ) |
|
load ( String path, String type_hint="", CacheMode cache_mode=1 ) |
|
load_threaded_get ( String path ) |
|
load_threaded_get_status ( String path, Array progress=[] ) |
|
load_threaded_request ( String path, String type_hint="", bool use_sub_threads=false, CacheMode cache_mode=1 ) |
|
void |
remove_resource_format_loader ( ResourceFormatLoader format_loader ) |
void |
set_abort_on_missing_resources ( bool abort ) |
Enumerations¶
enum ThreadLoadStatus:
ThreadLoadStatus THREAD_LOAD_INVALID_RESOURCE = 0
The resource is invalid, or has not been loaded with load_threaded_request.
ThreadLoadStatus THREAD_LOAD_IN_PROGRESS = 1
The resource is still being loaded.
ThreadLoadStatus THREAD_LOAD_FAILED = 2
Some error occurred during loading and it failed.
ThreadLoadStatus THREAD_LOAD_LOADED = 3
The resource was loaded successfully and can be accessed via load_threaded_get.
enum CacheMode:
CacheMode CACHE_MODE_IGNORE = 0
CacheMode CACHE_MODE_REUSE = 1
CacheMode CACHE_MODE_REPLACE = 2
Method Descriptions¶
void add_resource_format_loader ( ResourceFormatLoader format_loader, bool at_front=false )
Registers a new ResourceFormatLoader. The ResourceLoader will use the ResourceFormatLoader as described in load.
This method is performed implicitly for ResourceFormatLoaders written in GDScript (see ResourceFormatLoader for more information).
bool exists ( String path, String type_hint="" )
Returns whether a recognized resource exists for the given path.
An optional type_hint can be used to further specify the Resource type that should be handled by the ResourceFormatLoader. Anything that inherits from Resource can be used as a type hint, for example Image.
PackedStringArray get_dependencies ( String path )
Returns the dependencies for the resource at the given