Struct ResourceLoaderSingleton
Singleton used to load resource files.
struct ResourceLoaderSingleton
;
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.
GDScript has a simplified @GDScript built-in method which can be used in most situations, leaving the use of ResourceLoader for more advanced scenarios.
Methods
| Name | Description |
|---|---|
exists
|
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.
|
getDependencies
|
Returns the dependencies for the resource at the given path.
|
getRecognizedExtensionsForType
|
Returns the list of recognized extensions for a resource type. |
has
|
Deprecated method. Use hasCached or exists instead.
|
hasCached
|
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 load or loadInteractive methods will use the cached version. The cached resource can be overridden by using Resource on a new resource for that same path.
|
load
|
Loads a resource at the given path, caching the result for further access.
The registered ResourceFormatLoaders 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 Resource type that should be handled by the ResourceFormatLoader.
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.
Returns an empty resource if no ResourceFormatLoader could handle the file.
|
loadInteractive
|
Starts loading a resource interactively. The returned ResourceInteractiveLoader object allows to load with high granularity, calling its ResourceInteractiveLoader method successively to load chunks.
An optional type_hint can be used to further specify the Resource type that should be handled by the ResourceFormatLoader.
|
setAbortOnMissingResources
|
Changes the behavior on missing sub-resources. The default behavior is to abort loading. |