From 737bfa57d3bbac8dca12cc143ed4b3730e7a6dfb Mon Sep 17 00:00:00 2001
From: kobewi <kobewi4e@gmail.com>
Date: Tue, 30 Aug 2022 13:32:34 +0200
Subject: [PATCH] Allow to change the Stop shortcut used at runtime

(cherry picked from commit 409613ba7ba50e6cc985c61f6dcc482bac68746e)
---
 editor/editor_run.cpp     |  5 +++++
 scene/main/scene_tree.cpp | 32 ++++++++++++++++++++++++++++++--
 scene/main/scene_tree.h   |  4 ++++
 3 files changed, 39 insertions(+), 2 deletions(-)

diff --git a/editor/editor_run.cpp b/editor/editor_run.cpp
index 7dc30b5a76b..407f843d5a2 100644
--- a/editor/editor_run.cpp
+++ b/editor/editor_run.cpp
@@ -235,6 +235,11 @@ Error EditorRun::run(const String &p_scene, const String &p_custom_args, const L
 		}
 	}
 
+	// Pass the debugger stop shortcut to the running instance(s).
+	String shortcut;
+	VariantWriter::write_to_string(ED_GET_SHORTCUT("editor/stop"), shortcut);
+	OS::get_singleton()->set_environment("__GODOT_EDITOR_STOP_SHORTCUT__", shortcut);
+
 	printf("Running: %ls", exec.c_str());
 	for (List<String>::Element *E = args.front(); E; E = E->next()) {
 		printf(" %ls", E->get().c_str());
diff --git a/scene/main/scene_tree.cpp b/scene/main/scene_tree.cpp
index 8a0240069b9..774ed869e7f 100644
--- a/scene/main/scene_tree.cpp
+++ b/scene/main/scene_tree.cpp
@@ -38,10 +38,12 @@
 #include "core/os/os.h"
 #include "core/print_string.h"
 #include "core/project_settings.h"
+#include "core/variant_parser.h"
 #include "main/input_default.h"
 #include "node.h"
 #include "scene/animation/scene_tree_tween.h"
 #include "scene/debugger/script_debugger_remote.h"
+#include "scene/gui/shortcut.h"
 #include "scene/resources/dynamic_font.h"
 #include "scene/resources/material.h"
 #include "scene/resources/mesh.h"
@@ -463,9 +465,35 @@ void SceneTree::input_event(const Ref<InputEvent> &p_event) {
 	call_group_flags(GROUP_CALL_REALTIME, "_viewports", "_vp_input", ev); //special one for GUI, as controls use their own process check
 
 	if (ScriptDebugger::get_singleton() && ScriptDebugger::get_singleton()->is_remote()) {
-		//quit from game window using F8
+		// Quit from game window using the stop shortcut (F8 by default).
+		// The custom shortcut is provided via environment variable when running from the editor.
+		if (debugger_stop_shortcut.is_null()) {
+			String shortcut_str = OS::get_singleton()->get_environment("__GODOT_EDITOR_STOP_SHORTCUT__");
+			if (!shortcut_str.empty()) {
+				Variant shortcut_var;
+
+				VariantParser::StreamString ss;
+				ss.s = shortcut_str;
+
+				String errs;
+				int line;
+				VariantParser::parse(&ss, shortcut_var, errs, line);
+				debugger_stop_shortcut = shortcut_var;
+			}
+
+			if (debugger_stop_shortcut.is_null()) {
+				// Define a default shortcut if it wasn't provided or is invalid.
+				Ref<InputEventKey> ie;
+				ie.instance();
+				ie->set_scancode(KEY_F8);
+				ie->set_unicode(KEY_F8);
+				debugger_stop_shortcut.instance();
+				debugger_stop_shortcut->set_shortcut(ie);
+			}
+		}
+
 		Ref<InputEventKey> k = ev;
-		if (k.is_valid() && k->is_pressed() && !k->is_echo() && k->get_scancode() == KEY_F8) {
+		if (k.is_valid() && k->is_pressed() && !k->is_echo() && debugger_stop_shortcut->is_shortcut(k)) {
 			ScriptDebugger::get_singleton()->request_quit();
 		}
 	}
diff --git a/scene/main/scene_tree.h b/scene/main/scene_tree.h
index b3c994b0b8c..6117065e478 100644
--- a/scene/main/scene_tree.h
+++ b/scene/main/scene_tree.h
@@ -42,6 +42,7 @@
 class PackedScene;
 class Node;
 class SceneTreeTween;
+class ShortCut;
 class Spatial;
 class Viewport;
 class Material;
@@ -230,6 +231,9 @@ private:
 	SelfList<Node>::List xform_change_list;
 
 	friend class ScriptDebuggerRemote;
+
+	Ref<ShortCut> debugger_stop_shortcut;
+
 #ifdef DEBUG_ENABLED
 
 	Map<int, NodePath> live_edit_node_path_cache;