Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

ResourcePreloader

Inherits: Node < Object

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

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

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

---

Method Descriptions

void add_resource ( StringName 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 ( StringName name ) const

Returns the resource associated to name.

---

PackedStringArray get_resource_list ( ) const

Returns the list of resources inside the preloader.

---

bool has_resource ( StringName name ) const

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

---

void remove_resource ( StringName name )

Removes the resource associated to name from the preloader.

---

void rename_resource ( StringName name, StringName newname )

Renames a resource inside the preloader from name to newname.