mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
95 lines
5.9 KiB
ReStructuredText
95 lines
5.9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the ResourcePreloader.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_ResourcePreloader:
|
|
|
|
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
|
|
-------------------
|
|
|
|
.. _class_ResourcePreloader_method_add_resource:
|
|
|
|
- void **add_resource** **(** :ref:`StringName<class_StringName>` name, :ref:`Resource<class_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.
|
|
|
|
----
|
|
|
|
.. _class_ResourcePreloader_method_get_resource:
|
|
|
|
- :ref:`Resource<class_Resource>` **get_resource** **(** :ref:`StringName<class_StringName>` name **)** |const|
|
|
|
|
Returns the resource associated to ``name``.
|
|
|
|
----
|
|
|
|
.. _class_ResourcePreloader_method_get_resource_list:
|
|
|
|
- :ref:`PackedStringArray<class_PackedStringArray>` **get_resource_list** **(** **)** |const|
|
|
|
|
Returns the list of resources inside the preloader.
|
|
|
|
----
|
|
|
|
.. _class_ResourcePreloader_method_has_resource:
|
|
|
|
- :ref:`bool<class_bool>` **has_resource** **(** :ref:`StringName<class_StringName>` name **)** |const|
|
|
|
|
Returns ``true`` if the preloader contains a resource associated to ``name``.
|
|
|
|
----
|
|
|
|
.. _class_ResourcePreloader_method_remove_resource:
|
|
|
|
- void **remove_resource** **(** :ref:`StringName<class_StringName>` name **)**
|
|
|
|
Removes the resource associated to ``name`` from the preloader.
|
|
|
|
----
|
|
|
|
.. _class_ResourcePreloader_method_rename_resource:
|
|
|
|
- void **rename_resource** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` newname **)**
|
|
|
|
Renames a resource inside the preloader from ``name`` to ``newname``.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|