ResourceLoaderSingleton

Singleton used to load resource files.

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.

@GodotBaseClass

struct ResourceLoaderSingleton {

package

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(ResourceLoaderSingleton other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static ResourceLoaderSingleton _new();

bool exists(String path, String type_hint);

PoolStringArray getDependencies(String path);

PoolStringArray getRecognizedExtensionsForType(String type);

bool has(String path);

bool hasCached(String path);

Ref!Resource load(String path, String type_hint, bool no_cache);

Ref!ResourceInteractiveLoader loadInteractive(String path, String type_hint);

void setAbortOnMissingResources(bool abort);

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

exists 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.
getDependencies PoolStringArray getDependencies(String path): Returns the dependencies for the resource at the given path.
getRecognizedExtensionsForType PoolStringArray getRecognizedExtensionsForType(String type): Returns the list of recognized extensions for a resource type.
has bool has(String path): Deprecated method. Use hasCached or exists instead.
hasCached bool hasCached(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 load or loadInteractive methods will use the cached version. The cached resource can be overridden by using Resource.takeOverPath on a new resource for that same path.
load Ref!Resource load(String path, String type_hint, bool no_cache): 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. Anything that inherits from Resource can be used as a type hint, for example Image. 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. GDScript has a simplified @GDScript.load built-in method which can be used in most situations, leaving the use of ResourceLoader for more advanced scenarios.
loadInteractive Ref!ResourceInteractiveLoader loadInteractive(String path, String type_hint): Starts loading a resource interactively. The returned ResourceInteractiveLoader object allows to load with high granularity, calling its ResourceInteractiveLoader.poll 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. Anything that inherits from Resource can be used as a type hint, for example Image.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(ResourceLoaderSingleton other)
opEquals bool opEquals(typeof(null) n)
setAbortOnMissingResources void setAbortOnMissingResources(bool abort): Changes the behavior on missing sub-resources. The default behavior is to abort loading.
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Static functions

_new ResourceLoaderSingleton _new(): Construct a new instance of ResourceLoaderSingleton. Note: use memnew!ResourceLoaderSingleton instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

ResourceLoaderSingleton

Members

Aliases

Functions

Mixins

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

ResourceLoaderSingleton

From mixin baseCasts

From `mixin baseCasts`