Node: Rename child_exited_tree to child_exiting_tree

The name was confusing as this signal is emitted around the same time as `tree_exiting` and `NOTIFICATION_EXIT_TREE`, i.e. while the child node is still in tree. Fixes #59210.
godotengine · Jun 20, 2022 · 3e6de68 · 3e6de68
1 parent ff9a660
commit 3e6de68
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml
@@ -778,12 +778,14 @@
  <argument index="0" name="node" type="Node" />
  <description>
  Emitted when a child node enters the scene tree, either because it entered on its own or because this node entered with it.
+ This signal is emitted [i]after[/i] the child node's own [constant NOTIFICATION_ENTER_TREE] and [signal tree_entered].
  </description>
  </signal>
- <signal name="child_exited_tree">
+ <signal name="child_exiting_tree">
  <argument index="0" name="node" type="Node" />
  <description>
- Emitted when a child node exits the scene tree, either because it exited on its own or because this node exited.
+ Emitted when a child node is about to exit the scene tree, either because it is being removed or freed directly, or because this node is exiting the tree.
+ When this signal is received, the child [code]node[/code] is still in the tree and valid. This signal is emitted [i]after[/i] the child node's own [signal tree_exiting] and [constant NOTIFICATION_EXIT_TREE].
  </description>
  </signal>
  <signal name="ready">
@@ -799,6 +801,7 @@
  <signal name="tree_entered">
  <description>
  Emitted when the node enters the tree.
+ This signal is emitted [i]after[/i] the related [constant NOTIFICATION_ENTER_TREE] notification.
  </description>
  </signal>
  <signal name="tree_exited">
@@ -809,15 +812,18 @@
  <signal name="tree_exiting">
  <description>
  Emitted when the node is still active but about to exit the tree. This is the right place for de-initialization (or a "destructor", if you will).
+ This signal is emitted [i]before[/i] the related [constant NOTIFICATION_EXIT_TREE] notification.
  </description>
  </signal>
  </signals>
  <constants>
  <constant name="NOTIFICATION_ENTER_TREE" value="10">
  Notification received when the node enters a [SceneTree].
+ This notification is emitted [i]before[/i] the related [signal tree_entered].
  </constant>
  <constant name="NOTIFICATION_EXIT_TREE" value="11">
  Notification received when the node is about to exit a [SceneTree].
+ This notification is emitted [i]after[/i] the related [signal tree_exiting].
  </constant>
  <constant name="NOTIFICATION_MOVED_IN_PARENT" value="12">
  Notification received when the node is moved in the parent.

diff --git a/scene/main/node.cpp b/scene/main/node.cpp
@@ -300,7 +300,7 @@ void Node::_propagate_exit_tree() {
  if (data.parent) {
  Variant c = this;
  const Variant *cptr = &c;
- data.parent->emit_signalp(SNAME("child_exited_tree"), &cptr, 1);
+ data.parent->emit_signalp(SNAME("child_exiting_tree"), &cptr, 1);
  }
 
  // exit groups
@@ -2973,7 +2973,7 @@ void Node::_bind_methods() {
  ADD_SIGNAL(MethodInfo("tree_exiting"));
  ADD_SIGNAL(MethodInfo("tree_exited"));
  ADD_SIGNAL(MethodInfo("child_entered_tree", PropertyInfo(Variant::OBJECT, "node", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT, "Node")));
- ADD_SIGNAL(MethodInfo("child_exited_tree", PropertyInfo(Variant::OBJECT, "node", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT, "Node")));
+ ADD_SIGNAL(MethodInfo("child_exiting_tree", PropertyInfo(Variant::OBJECT, "node", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT, "Node")));
 
  ADD_PROPERTY(PropertyInfo(Variant::STRING_NAME, "name", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE), "set_name", "get_name");
  ADD_PROPERTY(PropertyInfo(Variant::BOOL, "unique_name_in_owner", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR), "set_unique_name_in_owner", "is_unique_name_in_owner");