Add SceneTree signal "game_quit" for quitting the game, and "suppress…

…_tree_exit_signal" bool to nodes.
Valla-Chan · Jan 19, 2024 · 4a1f7c5 · 4a1f7c5
1 parent 49b5dc9
commit 4a1f7c5
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 2 deletions.
diff --git a/scene/main/node.cpp b/scene/main/node.cpp
@@ -316,7 +316,7 @@ void Node::_propagate_after_exit_branch(bool p_exiting_tree) {
 
 	if (p_exiting_tree) {
 		emit_signal(SceneStringNames::get_singleton()->tree_exited);
-	}
+	} 
 }
 
 void Node::_propagate_exit_tree() {
@@ -354,7 +354,10 @@ void Node::_propagate_exit_tree() {
 	if (get_script_instance()) {
 		get_script_instance()->call_multilevel(SceneStringNames::get_singleton()->_exit_tree, nullptr, 0);
 	}
-	emit_signal(SceneStringNames::get_singleton()->tree_exiting);
+	if (!get_suppress_tree_exit_signal())
+		emit_signal(SceneStringNames::get_singleton()->tree_exiting);
+	else
+		set_suppress_tree_exit_signal(false);
 
 	notification(NOTIFICATION_EXIT_TREE, true);
 	if (data.tree) {
@@ -1682,6 +1685,14 @@ void Node::_acquire_unique_name_in_owner() {
 	data.owner->data.owned_unique_nodes[key] = this;
 }
 
+void Node::set_suppress_tree_exit_signal(bool p_suppress) {
+	data.suppress_tree_exit_signal = p_suppress;
+}
+
+bool Node::get_suppress_tree_exit_signal() {
+	return data.suppress_tree_exit_signal;
+}
+
 void Node::set_unique_name_in_owner(bool p_enabled) {
 	if (data.unique_name_in_owner == p_enabled) {
 		return;
@@ -3060,6 +3071,8 @@ void Node::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("get_filename"), &Node::get_filename);
 	ClassDB::bind_method(D_METHOD("propagate_notification", "what"), &Node::propagate_notification);
 	ClassDB::bind_method(D_METHOD("propagate_call", "method", "args", "parent_first"), &Node::propagate_call, DEFVAL(Array()), DEFVAL(false));
+	ClassDB::bind_method(D_METHOD("set_suppress_tree_exit_signal", "priority"), &Node::set_suppress_tree_exit_signal);
+	ClassDB::bind_method(D_METHOD("get_suppress_tree_exit_signal"), &Node::get_suppress_tree_exit_signal);
 	ClassDB::bind_method(D_METHOD("set_physics_process", "enable"), &Node::set_physics_process);
 	ClassDB::bind_method(D_METHOD("get_physics_process_delta_time"), &Node::get_physics_process_delta_time);
 	ClassDB::bind_method(D_METHOD("is_physics_processing"), &Node::is_physics_processing);
@@ -3235,6 +3248,7 @@ void Node::_bind_methods() {
 	ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "custom_multiplayer", PROPERTY_HINT_RESOURCE_TYPE, "MultiplayerAPI", 0), "set_custom_multiplayer", "get_custom_multiplayer");
 
 	ADD_GROUP("Process", "process_");
+	ADD_PROPERTY(PropertyInfo(Variant::STRING, "suppress_tree_exit_signal", PROPERTY_HINT_NONE, "Suppress,Allow", PROPERTY_USAGE_NOEDITOR), "set_suppress_tree_exit_signal", "get_suppress_tree_exit_signal");
 	ADD_PROPERTY(PropertyInfo(Variant::INT, "physics_interpolation_mode", PROPERTY_HINT_ENUM, "Inherit,Off,On"), "set_physics_interpolation_mode", "get_physics_interpolation_mode");
 	ADD_PROPERTY(PropertyInfo(Variant::INT, "process_mode", PROPERTY_HINT_ENUM, "Inherit,Pausable,WhenPaused,Always,Disabled"), "set_process_mode", "get_process_mode");
 	ADD_PROPERTY(PropertyInfo(Variant::INT, "process_priority"), "set_process_priority", "get_process_priority");
@@ -3273,6 +3287,7 @@ Node::Node() {
 	data.blocked = 0;
 	data.parent = nullptr;
 	data.tree = nullptr;
+	data.suppress_tree_exit_signal = false;
 	data.physics_process = false;
 	data.idle_process = false;
 	data.process_priority = 0;

diff --git a/scene/main/node.h b/scene/main/node.h
@@ -139,6 +139,8 @@ class Node : public Object {
 
 		int process_priority;
 
+		bool suppress_tree_exit_signal;
+
 		// Keep bitpacked values together to get better packing
 		//ProcessMode pause_mode : 2;
 		PhysicsInterpolationMode physics_interpolation_mode : 2;
@@ -360,6 +362,9 @@ class Node : public Object {
 	Node *get_owner() const;
 	void get_owned_by(Node *p_by, List<Node *> *p_owned);
 
+	void set_suppress_tree_exit_signal(bool p_suppress);
+	bool get_suppress_tree_exit_signal();
+
 	void set_unique_name_in_owner(bool p_enabled);
 	bool is_unique_name_in_owner() const;
 

diff --git a/scene/main/scene_tree.cpp b/scene/main/scene_tree.cpp
@@ -760,6 +760,7 @@ void SceneTree::finish() {
 }
 
 void SceneTree::quit(int p_exit_code) {
+	emit_signal("game_quit");
 	if (p_exit_code >= 0) {
 		// Override the exit code if a positive argument is given (the default is `-1`).
 		// This is a shorthand for calling `set_exit_code()` on the OS singleton then quitting.
@@ -2099,6 +2100,7 @@ void SceneTree::_bind_methods() {
 	ADD_SIGNAL(MethodInfo("connected_to_server"));
 	ADD_SIGNAL(MethodInfo("connection_failed"));
 	ADD_SIGNAL(MethodInfo("server_disconnected"));
+	ADD_SIGNAL(MethodInfo("game_quit"));
 
 	BIND_ENUM_CONSTANT(GROUP_CALL_DEFAULT);
 	BIND_ENUM_CONSTANT(GROUP_CALL_REVERSE);