Skip to content

Latest commit

 

History

History
88 lines (53 loc) · 5.16 KB

class_resourcepreloader.rst

File metadata and controls

88 lines (53 loc) · 5.16 KB
github_url:hide

ResourcePreloader

Inherits: :ref:`Node<class_Node>` < :ref:`Object<class_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 :ref:`@GDScript.preload<class_@GDScript_method_preload>` built-in method which can be used in most situations, leaving the use of ResourcePreloader for more advanced scenarios.

Methods

void :ref:`add_resource<class_ResourcePreloader_method_add_resource>` ( :ref:`StringName<class_StringName>` name, :ref:`Resource<class_Resource>` resource )
:ref:`Resource<class_Resource>` :ref:`get_resource<class_ResourcePreloader_method_get_resource>` ( :ref:`StringName<class_StringName>` name ) const
:ref:`PackedStringArray<class_PackedStringArray>` :ref:`get_resource_list<class_ResourcePreloader_method_get_resource_list>` ( ) const
:ref:`bool<class_bool>` :ref:`has_resource<class_ResourcePreloader_method_has_resource>` ( :ref:`StringName<class_StringName>` name ) const
void :ref:`remove_resource<class_ResourcePreloader_method_remove_resource>` ( :ref:`StringName<class_StringName>` name )
void :ref:`rename_resource<class_ResourcePreloader_method_rename_resource>` ( :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` newname )

Method Descriptions

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.


Returns the resource associated to name.


Returns the list of resources inside the preloader.


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


Removes the resource associated to name from the preloader.


Renames a resource inside the preloader from name to newname.