Stop changing the editor selection

dbnicholson · dbnicholson · commit 58983d0cd580 · 2024-09-23T22:38:01.000-06:00
Back in a808f67 and 43dd08b, the editor selection was dynamically updated so that both the BlockCode node and its parent were selected. This would open the parent node in the 2D/3D scene editor while the BlockCode node was open in the block canvas. However, selecting both nodes at the same time puts the editor into a multi-selection mode that makes interaction with the scene tree dock awkward. For example, clicking on another node does not select it for dragging. Furthermore, since some parts of the code operate on the selection while others wait to see the inspector's edited object is, there can be strange interactions when the selection is changed in the middle of an input action. What we really want is a way to say "make this the active scene in the scene editor" without selecting the node like we can with BlockCode nodes and the block canvas. That doesn't appear possible with Godot, so just always look at what the currently edited object in the inspector is and stop trying to activate the BlockCode parent in the scene editor. https://phabricator.endlessm.com/T35648
diff --git a/addons/block_code/block_code_plugin.gd b/addons/block_code/block_code_plugin.gd
@@ -13,7 +13,6 @@ const BlockInspectorPlugin := preload("res://addons/block_code/inspector_plugin/
 var block_inspector_plugin: BlockInspectorPlugin
 
 var editor_inspector: EditorInspector
-var editor_selection: EditorSelection
 
 var _selected_block_code: BlockCode
 
@@ -34,7 +33,6 @@ func _enter_tree():
 	Types.init_cast_graph()
 
 	editor_inspector = EditorInterface.get_inspector()
-	editor_selection = EditorInterface.get_selection()
 
 	main_panel = MainPanelScene.instantiate()
 	main_panel.script_window_requested.connect(script_window_requested)
@@ -100,31 +98,14 @@ func _ready():
 
 func _on_editor_inspector_edited_object_changed():
 	var edited_object = editor_inspector.get_edited_object()
-	#var edited_node = edited_object as Node
-	var selected_nodes = editor_selection.get_selected_nodes()
-
-	if edited_object is BlockCode:
+	var block_code_node = edited_object as BlockCode
+	if block_code_node:
+		# If a block code node was explicitly selected, activate the
+		# Block Code panel.
 		make_bottom_panel_item_visible(main_panel)
-
-	if edited_object is BlockCode and selected_nodes.size() == 1 and edited_object.owner and edited_object != _selected_block_code:
-		# If a BlockCode node is being edited, and it was explicitly selected
-		# (as opposed to edited in the Inspector alone), select its parent node
-		# as well. This provides a clearer indication of what is being edited.
-		# Changing the selection will cause edited_object_changed to fire again,
-		# so we will return early to avoid duplicate work.
-		var parent_node = edited_object.get_parent()
-		if parent_node:
-			editor_selection.add_node.call_deferred(parent_node)
-		return
-
-	if edited_object and edited_object.get_class() == "MultiNodeEdit":
-		# If multiple nodes are shown in the inspector, we will find the first
-		# BlockCode node in the list of selected nodes and use that. This
-		# occurs when the user selects multiple items in the Scene panel, or
-		# when we select the parent of a BlockCode node.
-		edited_object = selected_nodes.filter(func(node): return node is BlockCode).pop_front()
-
-	var block_code_node = list_block_code_nodes_for_node(edited_object as Node).pop_front()
+	else:
+		# Find the first block code child.
+		block_code_node = list_block_code_nodes_for_node(edited_object as Node).pop_front()
 	select_block_code_node(block_code_node)
 
 
diff --git a/addons/block_code/ui/main_panel.gd b/addons/block_code/ui/main_panel.gd
@@ -217,7 +217,7 @@ func _on_block_canvas_add_block_code():
 
 	undo_redo.add_do_method(edited_node, "add_child", block_code, true)
 	undo_redo.add_do_property(block_code, "owner", scene_root)
-	undo_redo.add_do_method(self, "_select_block_code_node", edited_node)
+	undo_redo.add_do_property(_context, "block_code_node", block_code)
 	undo_redo.add_do_reference(block_code)
 	undo_redo.add_undo_method(edited_node, "remove_child", block_code)
 	undo_redo.add_undo_property(block_code, "owner", null)
@@ -246,26 +246,11 @@ func _on_block_canvas_replace_block_code():
 	#        Ideally this should fix itself in a future version of Godot.
 
 	undo_redo.add_do_method(scene_root, "set_editable_instance", edited_node, true)
-	undo_redo.add_do_method(self, "_select_block_code_node", edited_node)
 	undo_redo.add_undo_method(scene_root, "set_editable_instance", edited_node, false)
 
 	undo_redo.commit_action()
 
 
-func _select_block_code_node(edited_node: Node):
-	var block_code_nodes = BlockCodePlugin.list_block_code_nodes_for_node(edited_node)
-	if block_code_nodes.size() > 0:
-		_set_selection([block_code_nodes.pop_front()])
-	else:
-		_set_selection([edited_node])
-
-
-func _set_selection(nodes: Array[Node]):
-	EditorInterface.get_selection().clear()
-	for node in nodes:
-		EditorInterface.get_selection().add_node(node)
-
-
 func _create_variable(variable: VariableDefinition):
 	if _context.block_code_node == null:
 		print("No script loaded to add variable to.")
diff --git a/addons/block_code/ui/title_bar/title_bar.gd b/addons/block_code/ui/title_bar/title_bar.gd
@@ -9,7 +9,6 @@ signal node_name_changed(node_name: String)
 
 @onready var _block_code_icon = load("res://addons/block_code/block_code_node/block_code_node.svg") as Texture2D
 @onready var _editor_inspector: EditorInspector = EditorInterface.get_inspector()
-@onready var _editor_selection: EditorSelection = EditorInterface.get_selection()
 @onready var _node_option_button: OptionButton = %NodeOptionButton
 
 
@@ -62,8 +61,4 @@ func _get_block_script_index(block_script: BlockScriptSerialization) -> int:
 
 func _on_node_option_button_item_selected(index):
 	var block_code_node = _node_option_button.get_item_metadata(index) as BlockCode
-	var parent_node = block_code_node.get_parent() as Node
-	_editor_selection.clear()
-	_editor_selection.add_node(block_code_node)
-	if parent_node:
-		_editor_selection.add_node(parent_node)
+	_context.block_code_node = block_code_node
