Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-12-08 06:09:55 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add unique Node IDs to support base and instantiated scene refactorings

Browse source 
The main goal of this PR is to safeguard when a base or instantiated scene changes (nodes renamed, moved or readded),
that the hierarchy is still maintained and the node and its overridden properties can be preserved.

What it does:
* Implements unique node IDs.
* These IDs act as a fallback to names when saving.
* The IDs are **USED AS A FALLBACK**, so they are just an addition. It should not break any current existing scene.
* If a scene renames or moves a node, inherited or instantiated scenes will no longer lose reference to it.

Unlike the previous approach, this one is intended to be a fallback, only used if the node is not found.
This makes it safer to implement and ensure that, at worst case, we fail to find the node, but nothing breaks.
This commit is contained in:
Juan 2025-05-26 20:01:34 +02:00 • committed by Rémi Verschelde
parent 60b7b8b16e
commit faddd60c40
No known key found for this signature in database
GPG key ID: C3336907360768E1
6 changed files with 370 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

18
scene/resources/packed_scene.h
View file

@ -39,6 +39,8 @@ class SceneState : public RefCounted {
Vector<StringName> names;
Vector<Variant> variants;
Vector<NodePath> node_paths;
Vector<PackedInt32Array> id_paths;
mutable PackedInt32Array ids;
Vector<NodePath> editable_instances;
mutable HashMap<NodePath, int> node_path_cache;
mutable HashMap<int, int> base_scene_node_remap;
@ -88,7 +90,7 @@ class SceneState : public RefCounted {
Vector<ConnectionData> connections;
Error _parse_node(Node *p_owner, Node *p_node, int p_parent_idx, HashMap<StringName, int> &name_map, HashMap<Variant, int, VariantHasher, VariantComparator> &variant_map, HashMap<Node *, int> &node_map, HashMap<Node *, int> &nodepath_map);
Error _parse_node(Node *p_owner, Node *p_node, int p_parent_idx, HashMap<StringName, int> &name_map, HashMap<Variant, int, VariantHasher, VariantComparator> &variant_map, HashMap<Node *, int> &node_map, HashMap<Node *, int> &nodepath_map, HashSet<int32_t> &ids_saved);
Error _parse_connections(Node *p_owner, Node *p_node, HashMap<StringName, int> &name_map, HashMap<Variant, int, VariantHasher, VariantComparator> &variant_map, HashMap<Node *, int> &node_map, HashMap<Node *, int> &nodepath_map);
String path;
@ -101,6 +103,8 @@ class SceneState : public RefCounted {
int _find_base_scene_node_remap_key(int p_idx) const;
Node *_recover_node_path_index(Node *p_base, int p_idx) const;
#ifdef TOOLS_ENABLED
public:
typedef void (*InstantiationWarningNotify)(const String &p_warning);
@ -171,7 +175,11 @@ public:
StringName get_node_type(int p_idx) const;
StringName get_node_name(int p_idx) const;
NodePath get_node_path(int p_idx, bool p_for_parent = false) const;
int32_t get_node_unique_id(int p_idx) const;
PackedInt32Array get_node_id_path(int p_idx) const;
PackedInt32Array get_node_parent_id_path(int p_idx) const;
NodePath get_node_owner_path(int p_idx) const;
PackedInt32Array get_node_owner_id_path(int p_idx) const;
Ref<PackedScene> get_node_instance(int p_idx) const;
String get_node_instance_placeholder(int p_idx) const;
bool is_node_instance_placeholder(int p_idx) const;
@ -188,6 +196,10 @@ public:
StringName get_connection_signal(int p_idx) const;
NodePath get_connection_target(int p_idx) const;
StringName get_connection_method(int p_idx) const;
PackedInt32Array get_connection_source_id_path(int p_idx) const;
PackedInt32Array get_connection_target_id_path(int p_idx) const;
int get_connection_flags(int p_idx) const;
int get_connection_unbinds(int p_idx) const;
Array get_connection_binds(int p_idx) const;
@ -202,8 +214,8 @@ public:
int add_name(const StringName &p_name);
int add_value(const Variant &p_value);
int add_node_path(const NodePath &p_path);
int add_node(int p_parent, int p_owner, int p_type, int p_name, int p_instance, int p_index);
int add_node_path(const NodePath &p_path, const PackedInt32Array &p_uid_path);
int add_node(int p_parent, int p_owner, int p_type, int p_name, int p_instance, int p_index, int32_t p_unique_id);
void add_node_property(int p_node, int p_name, int p_value, bool p_deferred_node_path = false);
void add_node_group(int p_node, int p_group);
void set_base_scene(int p_idx);