2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 01:03:48 +00:00
<class name= "ResourcePreloader" inherits= "Node" version= "4.0" >
2017-09-12 20:42:36 +00:00
<brief_description >
Resource Preloader Node.
</brief_description>
<description >
2019-02-07 16:00:16 +00:00
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.
2019-06-18 16:04:29 +00:00
GDScript has a simplified [method @GDScript.preload] built-in method which can be used in most situations, leaving the use of [ResourcePreloader] for more advanced scenarios.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "add_resource" >
<return type= "void" >
</return>
2020-02-22 13:59:09 +00:00
<argument index= "0" name= "name" type= "StringName" >
2017-09-12 20:42:36 +00:00
</argument>
<argument index= "1" name= "resource" type= "Resource" >
</argument>
<description >
2019-02-07 16:00:16 +00:00
Adds a resource to the preloader with the given [code]name[/code]. If a resource with the given [code]name[/code] already exists, the new resource will be renamed to "[code]name[/code] N" where N is an incrementing number starting from 2.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_resource" qualifiers= "const" >
<return type= "Resource" >
</return>
2020-02-22 13:59:09 +00:00
<argument index= "0" name= "name" type= "StringName" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2019-02-07 16:00:16 +00:00
Returns the resource associated to [code]name[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_resource_list" qualifiers= "const" >
2020-02-18 12:59:24 +00:00
<return type= "PackedStringArray" >
2017-09-12 20:42:36 +00:00
</return>
<description >
2019-02-07 16:00:16 +00:00
Returns the list of resources inside the preloader.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "has_resource" qualifiers= "const" >
<return type= "bool" >
</return>
2020-02-22 13:59:09 +00:00
<argument index= "0" name= "name" type= "StringName" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2019-04-17 11:42:56 +00:00
Returns [code]true[/code] if the preloader contains a resource associated to [code]name[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "remove_resource" >
<return type= "void" >
</return>
2020-02-22 13:59:09 +00:00
<argument index= "0" name= "name" type= "StringName" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2019-02-07 16:00:16 +00:00
Removes the resource associated to [code]name[/code] from the preloader.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "rename_resource" >
<return type= "void" >
</return>
2020-02-22 13:59:09 +00:00
<argument index= "0" name= "name" type= "StringName" >
2017-09-12 20:42:36 +00:00
</argument>
2020-02-22 13:59:09 +00:00
<argument index= "1" name= "newname" type= "StringName" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2019-02-07 16:00:16 +00:00
Renames a resource inside the preloader from [code]name[/code] to [code]newname[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<constants >
</constants>
</class>
