ResourceLoader

    Singleton used to load resource files.

    Singleton used to load resource files from the filesystem.

    It uses the many 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.

    • exists ( String path, type_hint=”” )

    Returns whether a recognized resource exists for the given .

    An optional type_hint can be used to further specify the Resource type that should be handled by the .



    Returns the list of recognized extensions for a resource type.


    Deprecated method. Use has_cached or instead.


    • bool has_cached ( path )

    Returns whether a cached resource is available for the given .

    Once a resource has been loaded by the engine, it is cached in memory for faster access, and future calls to the load or 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.


    • load ( String path, type_hint=””, bool no_cache=false )

    Loads a resource at the given path, caching the result for further access.

    An optional type_hint can be used to further specify the type that should be handled by the ResourceFormatLoader. Anything that inherits from can be used as a type hint, for example Image.

    If 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 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.


    Starts loading a resource interactively. The returned object allows to load with high granularity, calling its ResourceInteractiveLoader.poll method successively to load chunks.


    • void set_abort_on_missing_resources ( abort )

    Changes the behavior on missing sub-resources. The default behavior is to abort loading.