Allow editor plugins to modify run arguments and re-run from within project

Author: dsnopek

doc/classes/EditorPlugin.xml

@@ -362,6 +362,19 @@
 				Remember that you have to manage the visibility of all your editor controls manually.
 			</description>
 		</method>
+		<method name="_run_scene" qualifiers="virtual">
+			<return type="PackedStringArray" />
+			<param index="0" name="scene" type="String" />
+			<param index="1" name="args" type="PackedStringArray" />
+			<description>
+				This function will be called when the project or individual scene is about to be played in the editor. The [param args] to run Godot are passed in, and will be replaced by the return value.
+				[codeblock]
+				func _run_scene(scene, args):
+					args.push_back("--an-extra-argument")
+					return args
+				[/codeblock]
+			</description>
+		</method>
 		<method name="_save_external_data" qualifiers="virtual">
 			<return type="void" />
 			<description>

editor/debugger/editor_debugger_node.cpp

@@ -121,6 +121,7 @@ ScriptEditorDebugger *EditorDebuggerNode::_add_debugger() {
 	node->connect("set_breakpoint", callable_mp(this, &EditorDebuggerNode::_breakpoint_set_in_tree).bind(id));
 	node->connect("clear_breakpoints", callable_mp(this, &EditorDebuggerNode::_breakpoints_cleared_in_tree).bind(id));
 	node->connect("errors_cleared", callable_mp(this, &EditorDebuggerNode::_update_errors));
+	node->connect("run_scene_requested", callable_mp(this, &EditorDebuggerNode::_run_scene_requested).bind(id));
 
 	if (tabs->get_tab_count() > 0) {
 		get_debugger(0)->clear_style();
@@ -780,6 +781,24 @@ void EditorDebuggerNode::_save_node_requested(ObjectID p_id, const String &p_fil
 	get_current_debugger()->save_node(p_id, p_file);
 }
 
+void EditorDebuggerNode::_run_scene_requested(const String &p_scene, const Vector<String> &p_args, int p_debugger) {
+	EditorRunBar *editor_run_bar = EditorRunBar::get_singleton();
+	ERR_FAIL_NULL(editor_run_bar);
+
+	editor_run_bar->stop_playing();
+
+	// Defer starting the new one, so the old one has a chance to fully stop.
+	callable_mp(this, &EditorDebuggerNode::_run_scene_internal).call_deferred(editor_run_bar, p_scene, p_args);
+}
+
+void EditorDebuggerNode::_run_scene_internal(EditorRunBar *p_editor_run_bar, const String &p_scene, const Vector<String> &p_args) {
+	if (p_scene.is_empty()) {
+		p_editor_run_bar->play_main_scene(false);
+	} else {
+		p_editor_run_bar->play_custom_scene(p_scene, p_args);
+	}
+}
+
 void EditorDebuggerNode::_breakpoint_set_in_tree(Ref<RefCounted> p_script, int p_line, bool p_enabled, int p_debugger) {
 	if (p_debugger != tabs->get_current_tab()) {
 		return;

editor/debugger/editor_debugger_node.h

@@ -39,6 +39,7 @@ class DebugAdapterParser;
 class EditorDebuggerPlugin;
 class EditorDebuggerTree;
 class EditorDebuggerRemoteObjects;
+class EditorRunBar;
 class MenuButton;
 class ScriptEditorDebugger;
 class TabContainer;
@@ -143,6 +144,9 @@ class EditorDebuggerNode : public MarginContainer {
 	void _remote_selection_cleared(int p_debugger);
 	void _save_node_requested(ObjectID p_id, const String &p_file, int p_debugger);
 
+	void _run_scene_requested(const String &p_scene, const Vector<String> &p_args, int p_debugger);
+	void _run_scene_internal(EditorRunBar *p_editor_run_bar, const String &p_scene, const Vector<String> &p_args);
+
 	void _breakpoint_set_in_tree(Ref<RefCounted> p_script, int p_line, bool p_enabled, int p_debugger);
 	void _breakpoints_cleared_in_tree(int p_debugger);
 

editor/debugger/script_editor_debugger.cpp

@@ -926,6 +926,11 @@ void ScriptEditorDebugger::_msg_embed_next_frame(uint64_t p_thread_id, const Arr
 	emit_signal(SNAME("embed_shortcut_requested"), EMBED_NEXT_FRAME);
 }
 
+void ScriptEditorDebugger::_msg_run_scene(uint64_t p_thread_id, const Array &p_data) {
+	ERR_FAIL_COND(p_data.size() < 2);
+	emit_signal(SNAME("run_scene_requested"), p_data[0], p_data[1]);
+}
+
 void ScriptEditorDebugger::_parse_message(const String &p_msg, uint64_t p_thread_id, const Array &p_data) {
 	emit_signal(SNAME("debug_data"), p_msg, p_data);
 
@@ -976,6 +981,7 @@ void ScriptEditorDebugger::_init_parse_message_handlers() {
 	parse_message_handlers["window:title"] = &ScriptEditorDebugger::_msg_window_title;
 	parse_message_handlers["request_embed_suspend_toggle"] = &ScriptEditorDebugger::_msg_embed_suspend_toggle;
 	parse_message_handlers["request_embed_next_frame"] = &ScriptEditorDebugger::_msg_embed_next_frame;
+	parse_message_handlers["request_run_scene"] = &ScriptEditorDebugger::_msg_run_scene;
 }
 
 void ScriptEditorDebugger::_set_reason_text(const String &p_reason, MessageType p_type) {
@@ -1944,6 +1950,7 @@ void ScriptEditorDebugger::_bind_methods() {
 	ADD_SIGNAL(MethodInfo("clear_breakpoints"));
 	ADD_SIGNAL(MethodInfo("errors_cleared"));
 	ADD_SIGNAL(MethodInfo("embed_shortcut_requested", PropertyInfo(Variant::INT, "embed_shortcut_action")));
+	ADD_SIGNAL(MethodInfo("run_scene_requested", PropertyInfo(Variant::STRING, "scene"), PropertyInfo(Variant::PACKED_STRING_ARRAY, "args")));
 }
 
 void ScriptEditorDebugger::add_debugger_tab(Control *p_control) {

editor/debugger/script_editor_debugger.h

@@ -228,6 +228,7 @@ class ScriptEditorDebugger : public MarginContainer {
 	void _msg_window_title(uint64_t p_thread_id, const Array &p_data);
 	void _msg_embed_suspend_toggle(uint64_t p_thread_id, const Array &p_data);
 	void _msg_embed_next_frame(uint64_t p_thread_id, const Array &p_data);
+	void _msg_run_scene(uint64_t p_thread_id, const Array &p_data);
 
 	void _parse_message(const String &p_msg, uint64_t p_thread_id, const Array &p_data);
 	void _set_reason_text(const String &p_reason, MessageType p_type);

editor/editor_node.cpp

@@ -6975,6 +6975,15 @@ bool EditorNode::call_build() {
 	return builds_successful;
 }
 
+Vector<String> EditorNode::call_run_scene(const String &p_scene, const Vector<String> &p_args) {
+	Vector<String> args = p_args;
+	for (int i = 0; i < editor_data.get_editor_plugin_count(); i++) {
+		EditorPlugin *plugin = editor_data.get_editor_plugin(i);
+		args = plugin->run_scene(p_scene, args);
+	}
+	return args;
+}
+
 void EditorNode::_inherit_imported(const String &p_action) {
 	open_imported->hide();
 	load_scene(open_import_request, true, true);

editor/editor_node.h

@@ -727,6 +727,7 @@ class EditorNode : public Node {
 	void _on_plugin_ready(Object *p_script, const String &p_activate_name);
 
 	bool call_build();
+	Vector<String> call_run_scene(const String &p_scene, const Vector<String> &p_args);
 
 	// This is a very naive estimation, but we need something now. Will be reworked later.
 	bool is_editor_ready() const { return is_inside_tree() && !waiting_for_first_scan; }

editor/gui/editor_run_bar.cpp

@@ -315,8 +315,10 @@ void EditorRunBar::_run_scene(const String &p_scene_path, const Vector<String> &
 		return;
 	}
 
+	Vector<String> args = EditorNode::get_singleton()->call_run_scene(run_filename, p_run_args);
+
 	EditorDebuggerNode::get_singleton()->start();
-	Error error = editor_run.run(run_filename, write_movie_file, p_run_args);
+	Error error = editor_run.run(run_filename, write_movie_file, args);
 	if (error != OK) {
 		EditorDebuggerNode::get_singleton()->stop();
 		EditorNode::get_singleton()->show_accept(TTR("Could not start subprocess(es)!"), TTR("OK"));

editor/plugins/editor_plugin.cpp

@@ -531,6 +531,14 @@ bool EditorPlugin::build() {
 	return success;
 }
 
+Vector<String> EditorPlugin::run_scene(const String &p_scene, const Vector<String> &p_args) {
+	Vector<String> new_args;
+	if (GDVIRTUAL_CALL(_run_scene, p_scene, p_args, new_args)) {
+		return new_args;
+	}
+	return p_args;
+}
+
 void EditorPlugin::queue_save_layout() {
 	EditorNode::get_singleton()->save_editor_layout_delayed();
 }
@@ -665,6 +673,7 @@ void EditorPlugin::_bind_methods() {
 	GDVIRTUAL_BIND(_set_window_layout, "configuration");
 	GDVIRTUAL_BIND(_get_window_layout, "configuration");
 	GDVIRTUAL_BIND(_build);
+	GDVIRTUAL_BIND(_run_scene, "scene", "args");
 	GDVIRTUAL_BIND(_enable_plugin);
 	GDVIRTUAL_BIND(_disable_plugin);
 

editor/plugins/editor_plugin.h

@@ -133,6 +133,7 @@ class EditorPlugin : public Node {
 	GDVIRTUAL1(_set_window_layout, Ref<ConfigFile>)
 	GDVIRTUAL1(_get_window_layout, Ref<ConfigFile>)
 	GDVIRTUAL0R(bool, _build)
+	GDVIRTUAL2R(Vector<String>, _run_scene, String, Vector<String>)
 	GDVIRTUAL0(_enable_plugin)
 	GDVIRTUAL0(_disable_plugin)
 
@@ -202,6 +203,7 @@ class EditorPlugin : public Node {
 	virtual void get_window_layout(Ref<ConfigFile> p_layout);
 	virtual void edited_scene_changed() {} // if changes are pending in editor, apply them
 	virtual bool build(); // builds with external tools. Returns true if safe to continue running scene.
+	virtual Vector<String> run_scene(const String &p_scene, const Vector<String> &p_args);
 
 	EditorInterface *get_editor_interface();
 	ScriptCreateDialog *get_script_create_dialog();