godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
classes/class_resourcepreloader.rst
View File

@@ -14,76 +14,111 @@ ResourcePreloader
Resource Preloader Node.
.. rst-class:: classref-introduction-group
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.
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.
.. rst-class:: classref-reftable-group
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 **)** |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table::
:widths: auto
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_ResourcePreloader_method_add_resource:
- void **add_resource** **(** :ref:`StringName<class_StringName>` name, :ref:`Resource<class_Resource>` resource **)**
.. rst-class:: classref-method
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.
.. rst-class:: classref-item-separator
----
.. _class_ResourcePreloader_method_get_resource:
- :ref:`Resource<class_Resource>` **get_resource** **(** :ref:`StringName<class_StringName>` name **)** |const|
.. rst-class:: classref-method
:ref:`Resource<class_Resource>` **get_resource** **(** :ref:`StringName<class_StringName>` name **)** |const|
Returns the resource associated to ``name``.
.. rst-class:: classref-item-separator
----
.. _class_ResourcePreloader_method_get_resource_list:
- :ref:`PackedStringArray<class_PackedStringArray>` **get_resource_list** **(** **)** |const|
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **get_resource_list** **(** **)** |const|
Returns the list of resources inside the preloader.
.. rst-class:: classref-item-separator
----
.. _class_ResourcePreloader_method_has_resource:
- :ref:`bool<class_bool>` **has_resource** **(** :ref:`StringName<class_StringName>` name **)** |const|
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_resource** **(** :ref:`StringName<class_StringName>` name **)** |const|
Returns ``true`` if the preloader contains a resource associated to ``name``.
.. rst-class:: classref-item-separator
----
.. _class_ResourcePreloader_method_remove_resource:
- void **remove_resource** **(** :ref:`StringName<class_StringName>` name **)**
.. rst-class:: classref-method
void **remove_resource** **(** :ref:`StringName<class_StringName>` name **)**
Removes the resource associated to ``name`` from the preloader.
.. rst-class:: classref-item-separator
----
.. _class_ResourcePreloader_method_rename_resource:
- void **rename_resource** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` newname **)**
.. rst-class:: classref-method
void **rename_resource** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` newname **)**
Renames a resource inside the preloader from ``name`` to ``newname``.