Add game speed controls to the embedded game window

DexterFstone · DexterFstone · commit dd5849cd3e1e · 2025-06-09T21:38:24.000-07:00
diff --git a/core/config/engine.cpp b/core/config/engine.cpp
@@ -38,6 +38,18 @@
 #include "core/version.h"
 #include "servers/rendering/rendering_device.h"
 
+void Engine::_update_time_scale() {
+	double wanted_time_scale = time_scale_override_enabled
+			? time_scale_override * time_scale_base
+			: time_scale_base;
+
+	if (_time_scale == wanted_time_scale) {
+		return;
+	}
+
+	_time_scale = wanted_time_scale;
+}
+
 void Engine::set_physics_ticks_per_second(int p_ips) {
 	ERR_FAIL_COND_MSG(p_ips <= 0, "Engine iterations per second must be greater than 0.");
 	ips = p_ips;
@@ -113,6 +125,11 @@ uint32_t Engine::get_frame_delay() const {
 
 void Engine::set_time_scale(double p_scale) {
 	_time_scale = p_scale;
+	if (time_scale_base == p_scale) {
+		return;
+	}
+	time_scale_base = p_scale;
+	_update_time_scale();
 }
 
 double Engine::get_time_scale() const {
@@ -404,6 +421,38 @@ bool Engine::is_embedded_in_editor() const {
 	return embedded_in_editor;
 }
 
+void Engine::set_time_scale_base(double p_scale) {
+	print_line(p_scale);
+	time_scale_base = p_scale;
+}
+
+void Engine::set_time_scale_override(double p_scale) {
+	print_line("p_scale", p_scale);
+	if (time_scale_override == p_scale) {
+		return;
+	}
+	time_scale_override = p_scale;
+	if (is_time_scale_override_enabled()) {
+		_update_time_scale();
+	}
+}
+
+double Engine::get_time_scale_override() {
+	return time_scale_override;
+}
+
+void Engine::set_time_scale_override_enabled(bool p_enabled) {
+	if (time_scale_override_enabled == p_enabled) {
+		return;
+	}
+	time_scale_override_enabled = p_enabled;
+	_update_time_scale();
+}
+
+bool Engine::is_time_scale_override_enabled() {
+	return time_scale_override_enabled;
+}
+
 Engine::Engine() {
 	singleton = this;
 }
diff --git a/core/config/engine.h b/core/config/engine.h
@@ -101,6 +101,13 @@ class Engine {
 
 	bool freeze_time_scale = false;
 
+	double time_scale_base;
+	double time_scale_override;
+	bool time_scale_override_enabled;
+
+protected:
+	void _update_time_scale();
+
 public:
 	static Engine *get_singleton();
 
@@ -210,6 +217,12 @@ class Engine {
 	void set_embedded_in_editor(bool p_enabled);
 	bool is_embedded_in_editor() const;
 
+	void set_time_scale_override(double p_scale);
+	void set_time_scale_base(double p_scale);
+	double get_time_scale_override();
+	void set_time_scale_override_enabled(bool p_enabled);
+	bool is_time_scale_override_enabled();
+
 	Engine();
 	virtual ~Engine();
 };
diff --git a/editor/plugins/game_view_plugin.cpp b/editor/plugins/game_view_plugin.cpp
@@ -240,7 +240,6 @@ void GameView::_sessions_changed() {
 			active_sessions++;
 		}
 	}
-
 	_update_debugger_buttons();
 
 #ifdef MACOS_ENABLED
@@ -419,6 +418,7 @@ void GameView::_update_debugger_buttons() {
 
 	suspend_button->set_disabled(empty);
 	camera_override_button->set_disabled(empty);
+	speed_state_button->set_disabled(empty);
 
 	PopupMenu *menu = camera_override_menu->get_popup();
 
@@ -431,6 +431,9 @@ void GameView::_update_debugger_buttons() {
 		camera_override_button->set_pressed(false);
 	}
 	next_frame_button->set_disabled(!suspend_button->is_pressed());
+
+	time_scale_index = DEFUALT_TIME_SCALE_INDEX;
+	_update_time_scales();
 }
 
 void GameView::_handle_shortcut_requested(int p_embed_action) {
@@ -511,6 +514,37 @@ void GameView::_size_mode_button_pressed(int size_mode) {
 	_update_embed_window_size();
 }
 
+void GameView::_update_time_scales() {
+	Array message;
+	message.append(time_scale_index != DEFUALT_TIME_SCALE_INDEX);
+	message.append(time_scale_range[time_scale_index]);
+	Array sessions = debugger->get_sessions();
+	for (int i = 0; i < sessions.size(); i++) {
+		if (Object::cast_to<EditorDebuggerSession>(sessions[i])->is_active()) {
+			Ref<EditorDebuggerSession> session = sessions[i];
+			session->send_message("scene:speed_changed", message);
+		}
+	}
+	Color text_color;
+	if (time_scale_index == DEFUALT_TIME_SCALE_INDEX) {
+		text_color = Color(1.0f, 1.0f, 1.0f);
+	} else if (time_scale_index > DEFUALT_TIME_SCALE_INDEX) {
+		text_color = Color(0.0f, 1.0f, 0.0f);
+	} else if (time_scale_index < DEFUALT_TIME_SCALE_INDEX) {
+		text_color = Color(1.0f, 1.0f, 0.0f);
+	}
+	speed_state_button->add_theme_color_override("font_color", text_color);
+	speed_state_button->set_text(vformat("%0.2fx", time_scale_range[time_scale_index]));
+}
+
+void GameView::_speed_state_menu_pressed(int p_id) {
+	if (time_scale_index == p_id) {
+		return;
+	}
+	time_scale_index = p_id;
+	_update_time_scales();
+}
+
 GameView::EmbedAvailability GameView::_get_embed_available() {
 	if (!DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_WINDOW_EMBEDDING)) {
 		return EMBED_NOT_AVAILABLE_FEATURE_NOT_SUPPORTED;
@@ -995,6 +1029,20 @@ GameView::GameView(Ref<GameViewDebugger> p_debugger, EmbeddedProcessBase *p_embe
 	next_frame_button->set_accessibility_name(TTRC("Next Frame"));
 	next_frame_button->set_shortcut(ED_SHORTCUT("editor/next_frame_embedded_project", TTRC("Next Frame"), Key::F10));
 
+	speed_state_button = memnew(MenuButton);
+	main_menu_hbox->add_child(speed_state_button);
+	speed_state_button->set_text(TTRC("1.00x"));
+	speed_state_button->set_theme_type_variation("FlatButton");
+	speed_state_button->set_tooltip_text(TTRC("Reset the game speed."));
+	speed_state_button->set_accessibility_name(TTRC("Speed State"));
+	speed_state_button->set_custom_minimum_size(Vector2(48, 0));
+
+	PopupMenu *menu = speed_state_button->get_popup();
+	menu->connect(SceneStringName(id_pressed), callable_mp(this, &GameView::_speed_state_menu_pressed));
+	for (float f : time_scale_range) {
+		menu->add_item(TTRC(vformat("%0.2fx", f)));
+	}
+
 	main_menu_hbox->add_child(memnew(VSeparator));
 
 	node_type_button[RuntimeNodeSelect::NODE_TYPE_NONE] = memnew(Button);
@@ -1079,7 +1127,7 @@ GameView::GameView(Ref<GameViewDebugger> p_debugger, EmbeddedProcessBase *p_embe
 	camera_override_menu->set_tooltip_text(TTRC("Camera Override Options"));
 	camera_override_menu->set_accessibility_name(TTRC("Camera Override Options"));
 
-	PopupMenu *menu = camera_override_menu->get_popup();
+	menu = camera_override_menu->get_popup();
 	menu->connect(SceneStringName(id_pressed), callable_mp(this, &GameView::_camera_override_menu_id_pressed));
 	menu->add_item(TTRC("Reset 2D Camera"), CAMERA_RESET_2D);
 	menu->add_item(TTRC("Reset 3D Camera"), CAMERA_RESET_3D);
diff --git a/editor/plugins/game_view_plugin.h b/editor/plugins/game_view_plugin.h
@@ -157,6 +157,12 @@ class GameView : public VBoxContainer {
 	EmbeddedProcessBase *embedded_process = nullptr;
 	Label *state_label = nullptr;
 
+	int const DEFUALT_TIME_SCALE_INDEX = 5;
+	Array time_scale_range = { 0.0625f, 0.125f, 0.25f, 0.5f, 0.75f, 1.0f, 1.25f, 1.5f, 1.75f, 2.0f, 4.0f, 8.0f, 16.0f };
+	int time_scale_index = DEFUALT_TIME_SCALE_INDEX;
+
+	MenuButton *speed_state_button = nullptr;
+
 	void _sessions_changed();
 
 	void _update_debugger_buttons();
@@ -170,6 +176,9 @@ class GameView : public VBoxContainer {
 	void _embed_options_menu_menu_id_pressed(int p_id);
 	void _size_mode_button_pressed(int size_mode);
 
+	void _update_time_scales();
+	void _speed_state_menu_pressed(int p_id);
+
 	void _play_pressed();
 	static void _instance_starting_static(int p_idx, List<String> &r_arguments);
 	void _instance_starting(int p_idx, List<String> &r_arguments);
diff --git a/scene/debugger/scene_debugger.cpp b/scene/debugger/scene_debugger.cpp
@@ -183,6 +183,17 @@ Error SceneDebugger::_msg_next_frame(const Array &p_args) {
 	return OK;
 }
 
+Error SceneDebugger::_msg_speed_changed(const Array &p_args) {
+	bool enabled = Engine::get_singleton()->is_time_scale_override_enabled();
+	double time_scale = Engine::get_singleton()->get_time_scale();
+	if (!enabled) {
+		Engine::get_singleton()->set_time_scale_base(time_scale);
+	}
+	Engine::get_singleton()->set_time_scale_override_enabled(p_args[0]);
+	Engine::get_singleton()->set_time_scale_override(p_args[1]);
+	return OK;
+}
+
 Error SceneDebugger::_msg_debug_mute_audio(const Array &p_args) {
 	ERR_FAIL_COND_V(p_args.is_empty(), ERR_INVALID_DATA);
 	bool do_mute = p_args[0];
@@ -457,6 +468,7 @@ void SceneDebugger::_init_message_handlers() {
 	message_handlers["clear_selection"] = _msg_clear_selection;
 	message_handlers["suspend_changed"] = _msg_suspend_changed;
 	message_handlers["next_frame"] = _msg_next_frame;
+	message_handlers["speed_changed"] = _msg_speed_changed;
 	message_handlers["debug_mute_audio"] = _msg_debug_mute_audio;
 	message_handlers["override_cameras"] = _msg_override_cameras;
 	message_handlers["transform_camera_2d"] = _msg_transform_camera_2d;
diff --git a/scene/debugger/scene_debugger.h b/scene/debugger/scene_debugger.h
@@ -86,6 +86,7 @@ class SceneDebugger {
 	static Error _msg_clear_selection(const Array &p_args);
 	static Error _msg_suspend_changed(const Array &p_args);
 	static Error _msg_next_frame(const Array &p_args);
+	static Error _msg_speed_changed(const Array &p_args);
 	static Error _msg_debug_mute_audio(const Array &p_args);
 	static Error _msg_override_cameras(const Array &p_args);
 	static Error _msg_transform_camera_2d(const Array &p_args);
