ResourcePreloader

Inherits: Node < Object

Resource Preloader Node.

Description

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.

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

void	add_resource ( String name, Resource resource )
Resource	get_resource ( String name ) const
PoolStringArray	get_resource_list ( ) const
bool	has_resource ( String name ) const
void	remove_resource ( String name )
void	rename_resource ( String name, String newname )

Method Descriptions

void add_resource ( String name, Resource 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.

Resource get_resource ( String name ) const

Returns the resource associated to name.

PoolStringArray get_resource_list ( ) const

Returns the list of resources inside the preloader.

bool has_resource ( String name ) const

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

void remove_resource ( String name )

Removes the resource associated to name from the preloader.

void rename_resource ( String name, String newname )

Renames a resource inside the preloader from name to newname.