ResourceLoader

Inherits: Object Singleton used to load resource files.

Description

Singleton used to load resource files from the filesystem. 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.

Tutorials

• OS Test Demo

  Methods

  Method Descriptions

• bool exists ( String path, String type_hint=”” ) path. type_hint can be used to further specify the Resource type that should be handled by the ResourceFormatLoader.

• PoolStringArray get_dependencies ( String path ) path.

• PoolStringArray get_recognized_extensions_for_type ( String type ) Returns the list of recognized extensions for a resource type.

• bool has ( String path ) Deprecated method. Use has_cached or exists instead.

• bool has_cached ( String path ) path. load or load_interactive methods will use the cached version. The cached resource can be overridden by using Resource.take_over_path on a new resource for that same path.

• Resource load ( String path, String type_hint=””, bool no_cache=false ) path, caching the result for further access. 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. 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. 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. ResourceFormatLoader could handle the file. @GDScript.load built-in method which can be used in most situations, leaving the use of ResourceLoader for more advanced scenarios.

• ResourceInteractiveLoader load_interactive ( String path, String type_hint=”” ) ResourceInteractiveLoader object allows to load with high granularity, calling its ResourceInteractiveLoader.poll method successively to load chunks. 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.

• set_abort_on_missing_resources ( bool abort ) Changes the behavior on missing sub-resources. The default behavior is to abort loading.