Table of Contents

Class ResourcePreloader

A node used to preload sub-resources inside a scene.

Inheritance
ResourcePreloader

Remarks

This node is used to preload sub-resources inside a scene, so when the scene is loaded, all the resources are ready to use and can be retrieved from the preloader. You can add the resources using the ResourcePreloader tab when the node is selected.

GDScript has a simplified @GDScript.preload built-in method which can be used in most situations, leaving the use of ResourcePreloader for more advanced scenarios.

Methods

add_resource(StringName, Resource)

Adds a resource to the preloader with the given name. If a resource with the given name already exists, the new resource will be renamed to "name N" where N is an incrementing number starting from 2.

void add_resource(StringName name, Resource resource)

Parameters

name StringName
resource Resource

get_resource(StringName)

Qualifiers: const

Returns the resource associated to name.

Resource get_resource(StringName name)

Parameters

name StringName

get_resource_list

Qualifiers: const

Returns the list of resources inside the preloader.

PackedStringArray get_resource_list

has_resource(StringName)

Qualifiers: const

Returns true if the preloader contains a resource associated to name.

bool has_resource(StringName name)

Parameters

name StringName

remove_resource(StringName)

Removes the resource associated to name from the preloader.

void remove_resource(StringName name)

Parameters

name StringName

rename_resource(StringName, StringName)

Renames a resource inside the preloader from name to newname.

void rename_resource(StringName name, StringName newname)

Parameters

name StringName
newname StringName