ResourceInteractiveLoader

Interactive Resource loader.

This object is returned by ResourceLoader when performing an interactive load. It allows loading resources with high granularity, which makes it mainly useful for displaying loading bars or percentages.

@GodotBaseClass

struct ResourceInteractiveLoader {

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(ResourceInteractiveLoader other);

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

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static ResourceInteractiveLoader _new();

Ref!Resource getResource();

long getStage();

long getStageCount();

GodotError poll();

GodotError wait();

}

Members

Aliases

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

Functions

getResource Ref!Resource getResource(): Returns the loaded resource if the load operation completed successfully, null otherwise.
getStage long getStage(): Returns the load stage. The total amount of stages can be queried with getStageCount.
getStageCount long getStageCount(): Returns the total amount of stages (calls to poll) needed to completely load this resource.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(ResourceInteractiveLoader other)
opEquals bool opEquals(typeof(null) n)
poll GodotError poll(): Polls the loading operation, i.e. loads a data chunk up to the next stage. Returns constant OK if the poll is successful but the load operation has not finished yet (intermediate stage). This means poll will have to be called again until the last stage is completed. Returns constant ERR_FILE_EOF if the load operation has completed successfully. The loaded resource can be obtained by calling getResource. Returns another error code if the poll has failed.
toHash size_t toHash()
wait GodotError wait(): Polls the loading operation successively until the resource is completely loaded or a poll fails. Returns constant ERR_FILE_EOF if the load operation has completed successfully. The loaded resource can be obtained by calling getResource. Returns another error code if a poll has failed, aborting the operation.

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Static functions

_new ResourceInteractiveLoader _new(): Construct a new instance of ResourceInteractiveLoader. Note: use memnew!ResourceInteractiveLoader 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.

ResourceInteractiveLoader

Members

Aliases

Functions

Mixins

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

ResourceInteractiveLoader

From mixin baseCasts

From `mixin baseCasts`