ResourceInteractiveLoader

Inherits: Reference < Object

Category: Core

Brief Description

Interactive Resource Loader.

Methods

Resource get_resource ( )
int get_stage ( ) const
int get_stage_count ( ) const
Error poll ( )
Error wait ( )

Description

Interactive Resource Loader. This object is returned by ResourceLoader when performing an interactive load. It allows to load with high granularity, so this is mainly useful for displaying load bars/percentages.

Method Descriptions

Return the loaded resource (only if loaded). Otherwise, returns null.

  • int get_stage ( ) const

Return the load stage. The total amount of stages can be queried with get_stage_count

  • int get_stage_count ( ) const

Return the total amount of stages (calls to poll) needed to completely load this resource.

Poll the load. If OK is returned, this means poll will have to be called again. If ERR_FILE_EOF is returned, them the load has finished and the resource can be obtained by calling get_resource.