|
@@ -64,41 +64,41 @@ Methods
|
|
|
.. table::
|
|
|
:widths: auto
|
|
|
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`RID<class_RID>` | :ref:`_get_rid<class_Resource_private_method__get_rid>`\ (\ ) |virtual| |const| |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | |void| | :ref:`_reset_state<class_Resource_private_method__reset_state>`\ (\ ) |virtual| |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | |void| | :ref:`_set_path_cache<class_Resource_private_method__set_path_cache>`\ (\ path\: :ref:`String<class_String>`\ ) |virtual| |const| |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | |void| | :ref:`_setup_local_to_scene<class_Resource_private_method__setup_local_to_scene>`\ (\ ) |virtual| |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`Resource<class_Resource>` | :ref:`duplicate<class_Resource_method_duplicate>`\ (\ deep\: :ref:`bool<class_bool>` = false\ ) |const| |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`Resource<class_Resource>` | :ref:`duplicate_deep<class_Resource_method_duplicate_deep>`\ (\ deep_subresources_mode\: :ref:`ResourceDeepDuplicateMode<enum_Resource_ResourceDeepDuplicateMode>` = 1\ ) |const| |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | |void| | :ref:`emit_changed<class_Resource_method_emit_changed>`\ (\ ) |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`generate_scene_unique_id<class_Resource_method_generate_scene_unique_id>`\ (\ ) |static| |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`String<class_String>` | :ref:`get_id_for_path<class_Resource_method_get_id_for_path>`\ (\ path\: :ref:`String<class_String>`\ ) |const| |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`Node<class_Node>` | :ref:`get_local_scene<class_Resource_method_get_local_scene>`\ (\ ) |const| |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`RID<class_RID>` | :ref:`get_rid<class_Resource_method_get_rid>`\ (\ ) |const| |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | :ref:`bool<class_bool>` | :ref:`is_built_in<class_Resource_method_is_built_in>`\ (\ ) |const| |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | |void| | :ref:`reset_state<class_Resource_method_reset_state>`\ (\ ) |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | |void| | :ref:`set_id_for_path<class_Resource_method_set_id_for_path>`\ (\ path\: :ref:`String<class_String>`, id\: :ref:`String<class_String>`\ ) |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | |void| | :ref:`set_path_cache<class_Resource_method_set_path_cache>`\ (\ path\: :ref:`String<class_String>`\ ) |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | |void| | :ref:`setup_local_to_scene<class_Resource_method_setup_local_to_scene>`\ (\ ) |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
- | |void| | :ref:`take_over_path<class_Resource_method_take_over_path>`\ (\ path\: :ref:`String<class_String>`\ ) |
|
|
|
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | :ref:`RID<class_RID>` | :ref:`_get_rid<class_Resource_private_method__get_rid>`\ (\ ) |virtual| |const| |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | |void| | :ref:`_reset_state<class_Resource_private_method__reset_state>`\ (\ ) |virtual| |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | |void| | :ref:`_set_path_cache<class_Resource_private_method__set_path_cache>`\ (\ path\: :ref:`String<class_String>`\ ) |virtual| |const| |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | |void| | :ref:`_setup_local_to_scene<class_Resource_private_method__setup_local_to_scene>`\ (\ ) |virtual| |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | :ref:`Resource<class_Resource>` | :ref:`duplicate<class_Resource_method_duplicate>`\ (\ deep\: :ref:`bool<class_bool>` = false\ ) |const| |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | :ref:`Resource<class_Resource>` | :ref:`duplicate_deep<class_Resource_method_duplicate_deep>`\ (\ deep_subresources_mode\: :ref:`DeepDuplicateMode<enum_Resource_DeepDuplicateMode>` = 1\ ) |const| |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | |void| | :ref:`emit_changed<class_Resource_method_emit_changed>`\ (\ ) |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | :ref:`String<class_String>` | :ref:`generate_scene_unique_id<class_Resource_method_generate_scene_unique_id>`\ (\ ) |static| |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | :ref:`String<class_String>` | :ref:`get_id_for_path<class_Resource_method_get_id_for_path>`\ (\ path\: :ref:`String<class_String>`\ ) |const| |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | :ref:`Node<class_Node>` | :ref:`get_local_scene<class_Resource_method_get_local_scene>`\ (\ ) |const| |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | :ref:`RID<class_RID>` | :ref:`get_rid<class_Resource_method_get_rid>`\ (\ ) |const| |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | :ref:`bool<class_bool>` | :ref:`is_built_in<class_Resource_method_is_built_in>`\ (\ ) |const| |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | |void| | :ref:`reset_state<class_Resource_method_reset_state>`\ (\ ) |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | |void| | :ref:`set_id_for_path<class_Resource_method_set_id_for_path>`\ (\ path\: :ref:`String<class_String>`, id\: :ref:`String<class_String>`\ ) |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | |void| | :ref:`set_path_cache<class_Resource_method_set_path_cache>`\ (\ path\: :ref:`String<class_String>`\ ) |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | |void| | :ref:`setup_local_to_scene<class_Resource_method_setup_local_to_scene>`\ (\ ) |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+ | |void| | :ref:`take_over_path<class_Resource_method_take_over_path>`\ (\ path\: :ref:`String<class_String>`\ ) |
|
|
|
+ +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
|
@@ -142,33 +142,33 @@ Emitted by a newly duplicated resource with :ref:`resource_local_to_scene<class_
|
|
|
Enumerations
|
|
|
------------
|
|
|
|
|
|
-.. _enum_Resource_ResourceDeepDuplicateMode:
|
|
|
+.. _enum_Resource_DeepDuplicateMode:
|
|
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
|
|
-enum **ResourceDeepDuplicateMode**: :ref:`🔗<enum_Resource_ResourceDeepDuplicateMode>`
|
|
|
+enum **DeepDuplicateMode**: :ref:`🔗<enum_Resource_DeepDuplicateMode>`
|
|
|
|
|
|
-.. _class_Resource_constant_RESOURCE_DEEP_DUPLICATE_NONE:
|
|
|
+.. _class_Resource_constant_DEEP_DUPLICATE_NONE:
|
|
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
|
|
-:ref:`ResourceDeepDuplicateMode<enum_Resource_ResourceDeepDuplicateMode>` **RESOURCE_DEEP_DUPLICATE_NONE** = ``0``
|
|
|
+:ref:`DeepDuplicateMode<enum_Resource_DeepDuplicateMode>` **DEEP_DUPLICATE_NONE** = ``0``
|
|
|
|
|
|
No subresorces at all are duplicated. This is useful even in a deep duplication to have all the arrays and dictionaries duplicated but still pointing to the original resources.
|
|
|
|
|
|
-.. _class_Resource_constant_RESOURCE_DEEP_DUPLICATE_INTERNAL:
|
|
|
+.. _class_Resource_constant_DEEP_DUPLICATE_INTERNAL:
|
|
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
|
|
-:ref:`ResourceDeepDuplicateMode<enum_Resource_ResourceDeepDuplicateMode>` **RESOURCE_DEEP_DUPLICATE_INTERNAL** = ``1``
|
|
|
+:ref:`DeepDuplicateMode<enum_Resource_DeepDuplicateMode>` **DEEP_DUPLICATE_INTERNAL** = ``1``
|
|
|
|
|
|
Only subresources without a path or with a scene-local path will be duplicated.
|
|
|
|
|
|
-.. _class_Resource_constant_RESOURCE_DEEP_DUPLICATE_ALL:
|
|
|
+.. _class_Resource_constant_DEEP_DUPLICATE_ALL:
|
|
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
|
|
-:ref:`ResourceDeepDuplicateMode<enum_Resource_ResourceDeepDuplicateMode>` **RESOURCE_DEEP_DUPLICATE_ALL** = ``2``
|
|
|
+:ref:`DeepDuplicateMode<enum_Resource_DeepDuplicateMode>` **DEEP_DUPLICATE_ALL** = ``2``
|
|
|
|
|
|
Every subresource found will be duplicated, even if it has a non-local path. In other words, even potentially big resources stored separately will be duplicated.
|
|
|
|
|
@@ -249,7 +249,7 @@ The unique path to this resource. If it has been saved to disk, the value will b
|
|
|
- |void| **set_scene_unique_id**\ (\ value\: :ref:`String<class_String>`\ )
|
|
|
- :ref:`String<class_String>` **get_scene_unique_id**\ (\ )
|
|
|
|
|
|
-An unique identifier relative to the this resource's scene. If left empty, the ID is automatically generated when this resource is saved inside a :ref:`PackedScene<class_PackedScene>`. If the resource is not inside a scene, this property is empty by default.
|
|
|
+A unique identifier relative to the this resource's scene. If left empty, the ID is automatically generated when this resource is saved inside a :ref:`PackedScene<class_PackedScene>`. If the resource is not inside a scene, this property is empty by default.
|
|
|
|
|
|
\ **Note:** When the :ref:`PackedScene<class_PackedScene>` is saved, if multiple resources in the same scene use the same ID, only the earliest resource in the scene hierarchy keeps the original ID. The other resources are assigned new IDs from :ref:`generate_scene_unique_id()<class_Resource_method_generate_scene_unique_id>`.
|
|
|
|
|
@@ -335,7 +335,7 @@ Duplicates this resource, returning a new resource with its ``export``\ ed or :r
|
|
|
|
|
|
If ``deep`` is ``false``, a **shallow** copy is returned: nested :ref:`Array<class_Array>`, :ref:`Dictionary<class_Dictionary>`, and **Resource** properties are not duplicated and are shared with the original resource.
|
|
|
|
|
|
-If ``deep`` is ``true``, a **deep** copy is returned: all nested arrays, dictionaries, and packed arrays are also duplicated (recursively). Any **Resource** found inside will only be duplicated if it's local, like :ref:`RESOURCE_DEEP_DUPLICATE_INTERNAL<class_Resource_constant_RESOURCE_DEEP_DUPLICATE_INTERNAL>` used with :ref:`duplicate_deep()<class_Resource_method_duplicate_deep>`.
|
|
|
+If ``deep`` is ``true``, a **deep** copy is returned: all nested arrays, dictionaries, and packed arrays are also duplicated (recursively). Any **Resource** found inside will only be duplicated if it's local, like :ref:`DEEP_DUPLICATE_INTERNAL<class_Resource_constant_DEEP_DUPLICATE_INTERNAL>` used with :ref:`duplicate_deep()<class_Resource_method_duplicate_deep>`.
|
|
|
|
|
|
The following exceptions apply:
|
|
|
|
|
@@ -355,11 +355,11 @@ The following exceptions apply:
|
|
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|
|
-:ref:`Resource<class_Resource>` **duplicate_deep**\ (\ deep_subresources_mode\: :ref:`ResourceDeepDuplicateMode<enum_Resource_ResourceDeepDuplicateMode>` = 1\ ) |const| :ref:`🔗<class_Resource_method_duplicate_deep>`
|
|
|
+:ref:`Resource<class_Resource>` **duplicate_deep**\ (\ deep_subresources_mode\: :ref:`DeepDuplicateMode<enum_Resource_DeepDuplicateMode>` = 1\ ) |const| :ref:`🔗<class_Resource_method_duplicate_deep>`
|
|
|
|
|
|
Duplicates this resource, deeply, like :ref:`duplicate()<class_Resource_method_duplicate>`\ ``(true)``, with extra control over how subresources are handled.
|
|
|
|
|
|
-\ ``deep_subresources_mode`` must be one of the values from :ref:`ResourceDeepDuplicateMode<enum_Resource_ResourceDeepDuplicateMode>`.
|
|
|
+\ ``deep_subresources_mode`` must be one of the values from :ref:`DeepDuplicateMode<enum_Resource_DeepDuplicateMode>`.
|
|
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|