Make the "Quick Open" dialog available via `EditorInterface` #97633

ydeltastar · 2024-09-30T05:38:10Z

Allows to use the "Quick Open" dialog in tool scripts via the EditorInterface without exposing internal classes. Works the same as other editor popups added in #81655.

@tool
extends EditorScript

func _run():
	EditorInterface.popup_quick_open(_on_selected, "Texture2D", true, false, "Select Textures")

static func _on_selected(paths: PackedStringArray):
	print("Paths: %s" % paths)

Closes: Make EditorQuickOpen dialog available from plugins godot-proposals#3745

KoBeWi · 2024-10-03T13:59:50Z

Needs rebase after #56772

AThousandShips · 2024-10-03T15:45:01Z

editor/editor_interface.cpp

@@ -36,6 +36,7 @@
 #include "editor/editor_main_screen.h"
 #include "editor/editor_node.h"
 #include "editor/editor_paths.h"
+#include "editor/editor_quick_open.h"


Suggested change

#include "editor/editor_quick_open.h"

#include "editor/gui/editor_quick_open_dialog.h"

The way the dialog is used and some features changed. It will require a bit more changes.

ydeltastar · 2024-10-03T16:21:22Z

It is a close-on-selection dialogue now. Support for multi-selection was removed.
Will it be re-added or should I go with what it is now?

ydeltastar · 2024-10-03T18:37:48Z

I changed the arguments to match the new implementation. Also, there was no way to tell if the dialog was canceled since the new implementation uses a callback instead of signals and it doesn't call when canceled. I made changes so it calls with an empty string when canceled.

KoBeWi · 2024-10-03T20:34:24Z

editor/gui/editor_quick_open_dialog.cpp:94 - Condition "p_base_types.is_empty()" is true.

error when using default second argument. You can make it default to ["Resource"].

I made changes so it calls with an empty string when canceled.

Is it a problem that canceled dialog doesn't call the callback?

Will it be re-added or should I go with what it is now?

Opening multiple files with the dialog is rather rare, so it was removed to allow opening the file faster.

ydeltastar · 2024-10-03T21:39:40Z

error when using default second argument. You can make it default to ["Resource"].

Not sure if that's possible with the binding API, I couldn't find any example. I made it a required argument with an error check.

Is it a problem that canceled dialog doesn't call the callback?

Not for the editor's current behavior. But for addons the user may want a way to know. The other popups call it when canceled as well.

KoBeWi · 2024-10-03T21:41:26Z

You could use popup_hide signal then.

Not sure if that's possible with the binding API, I couldn't find any example.

You can make a TypedArray variable, append default and put it in DEFVAL.

KoBeWi · 2024-10-03T22:33:56Z

editor/editor_interface.cpp

@@ -336,6 +337,20 @@ void EditorInterface::popup_property_selector(Object *p_object, const Callable &
 	property_selector->connect(SNAME("canceled"), canceled_callback, CONNECT_DEFERRED);
 }

+void EditorInterface::popup_quick_open(const Callable &p_callback, const TypedArray<StringName> &p_base_types) {
+	ERR_FAIL_COND_MSG(p_base_types.is_empty(), "The list of base types for quick open dialog can't be empty.");


Alternatively, you can just append "Resource" when the array is empty.

ydeltastar · 2024-10-03T22:35:42Z

You could use popup_hide signal then.

Windows don't have it. Used canceled since EditorQuickOpenDialog is an AcceptDialog.

ydeltastar · 2024-10-03T23:33:41Z

You can make a TypedArray variable, append default and put it in DEFVAL.

Although it works fine CI is failing because the test suite doesn't support appended values for TypedArrays.

godot\tests/core/object/test_class_db.h(453): ERROR: CHECK_FALSE( !arg_defval_valid_data ) is NOT correct!
  values: CHECK_FALSE( true )
  logged: Invalid default value for parameter 'base_types' of method 'EditorInterface.popup_quick_open'. Must be zero.

KoBeWi · 2024-10-04T02:04:28Z

Well after you made popup_quick_open() auto-append if empty, you can make the default empty again.

editor/editor_interface.cpp

KoBeWi · 2024-10-04T12:14:47Z

editor/editor_interface.cpp

+	for (int i = 0; i < p_base_types.size(); i++) {
+		base_types.append(p_base_types[i]);


Suggested change

for (int i = 0; i < p_base_types.size(); i++) {

base_types.append(p_base_types[i]);

for (const StringName &type : p_base_types) {

base_types.append(type);

This is another thing with TypedArrays that fail CI even though it works fine.

Maybe you need to use Variant as type.

I don't see much benefit. TypedArrays are iterated with regular loops throughout the code base, including other PRs I did.

Likely because range iteration on Array wasn't supported until recently and there is legacy code.
But whatever, someone might make a cleanup pass in the future anyway.

KoBeWi · 2024-10-04T12:20:36Z

Looks good now. One last thing that would be nice is checking for supported types. QuickOpen dialog only supports Resource types, if you use e.g. Node or some non-existent type, the dialog will be empty with no proper feedback.

You can check valid types like this:

for (const StringName &type : p_base_types) {
	ERR_FAIL_COND_MSG(!ClassDB::is_parent_class(type, "Resource"), "Only Resource-deriving types are supported in QuickOpen.");
}

It should also be documented in the method's description.

editor/editor_interface.cpp

akien-mga · 2024-10-04T15:29:14Z

Thanks!

ydeltastar requested review from a team as code owners September 30, 2024 05:38

AThousandShips added enhancement topic:editor topic:plugin labels Sep 30, 2024

AThousandShips added this to the 4.x milestone Sep 30, 2024

ydeltastar force-pushed the quickly-quick-open branch from f2f9687 to 5736066 Compare October 3, 2024 15:22

AThousandShips reviewed Oct 3, 2024

View reviewed changes

ydeltastar force-pushed the quickly-quick-open branch from 5736066 to 74411f2 Compare October 3, 2024 18:19

ydeltastar requested review from a team as code owners October 3, 2024 18:19

ydeltastar force-pushed the quickly-quick-open branch from 74411f2 to cc21128 Compare October 3, 2024 21:39

KoBeWi reviewed Oct 3, 2024

View reviewed changes

ydeltastar force-pushed the quickly-quick-open branch from cc21128 to 09988b9 Compare October 3, 2024 22:35

ydeltastar force-pushed the quickly-quick-open branch 2 times, most recently from 70b2abe to 6f4e171 Compare October 3, 2024 22:59

ydeltastar force-pushed the quickly-quick-open branch from 6f4e171 to ca9bb07 Compare October 4, 2024 03:15

KoBeWi reviewed Oct 4, 2024

View reviewed changes

editor/editor_interface.cpp Outdated Show resolved Hide resolved

KoBeWi reviewed Oct 4, 2024

View reviewed changes

ydeltastar force-pushed the quickly-quick-open branch 2 times, most recently from 3b46b9d to 775b58b Compare October 4, 2024 14:22

KoBeWi reviewed Oct 4, 2024

View reviewed changes

editor/editor_interface.cpp Outdated Show resolved Hide resolved

KoBeWi approved these changes Oct 4, 2024

View reviewed changes

Make the "Quick Open" dialog available via EditorInterface

35b3999

ydeltastar force-pushed the quickly-quick-open branch from 775b58b to 35b3999 Compare October 4, 2024 14:36

akien-mga modified the milestones: 4.x, 4.4 Oct 4, 2024

akien-mga merged commit 428c4a6 into godotengine:master Oct 4, 2024
19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make the "Quick Open" dialog available via `EditorInterface` #97633

Make the "Quick Open" dialog available via `EditorInterface` #97633

ydeltastar commented Sep 30, 2024

KoBeWi commented Oct 3, 2024

AThousandShips Oct 3, 2024

ydeltastar Oct 3, 2024

ydeltastar commented Oct 3, 2024

ydeltastar commented Oct 3, 2024 •

edited

Loading

KoBeWi commented Oct 3, 2024 •

edited

Loading

ydeltastar commented Oct 3, 2024

KoBeWi commented Oct 3, 2024 •

edited

Loading

KoBeWi Oct 3, 2024

ydeltastar commented Oct 3, 2024 •

edited

Loading

ydeltastar commented Oct 3, 2024

KoBeWi commented Oct 4, 2024

KoBeWi Oct 4, 2024

ydeltastar Oct 4, 2024 •

edited

Loading

KoBeWi Oct 4, 2024

ydeltastar Oct 4, 2024

KoBeWi Oct 4, 2024 •

edited

Loading

KoBeWi commented Oct 4, 2024

akien-mga commented Oct 4, 2024

	#include "editor/editor_quick_open.h"
	#include "editor/gui/editor_quick_open_dialog.h"

		for (int i = 0; i < p_base_types.size(); i++) {
		base_types.append(p_base_types[i]);

Make the "Quick Open" dialog available via EditorInterface #97633

Make the "Quick Open" dialog available via EditorInterface #97633

Conversation

ydeltastar commented Sep 30, 2024

KoBeWi commented Oct 3, 2024

AThousandShips Oct 3, 2024

Choose a reason for hiding this comment

ydeltastar Oct 3, 2024

Choose a reason for hiding this comment

ydeltastar commented Oct 3, 2024

ydeltastar commented Oct 3, 2024 • edited Loading

KoBeWi commented Oct 3, 2024 • edited Loading

ydeltastar commented Oct 3, 2024

KoBeWi commented Oct 3, 2024 • edited Loading

KoBeWi Oct 3, 2024

Choose a reason for hiding this comment

ydeltastar commented Oct 3, 2024 • edited Loading

ydeltastar commented Oct 3, 2024

KoBeWi commented Oct 4, 2024

KoBeWi Oct 4, 2024

Choose a reason for hiding this comment

ydeltastar Oct 4, 2024 • edited Loading

Choose a reason for hiding this comment

KoBeWi Oct 4, 2024

Choose a reason for hiding this comment

ydeltastar Oct 4, 2024

Choose a reason for hiding this comment

KoBeWi Oct 4, 2024 • edited Loading

Choose a reason for hiding this comment

KoBeWi commented Oct 4, 2024

akien-mga commented Oct 4, 2024

Make the "Quick Open" dialog available via `EditorInterface` #97633

Make the "Quick Open" dialog available via `EditorInterface` #97633

ydeltastar commented Oct 3, 2024 •

edited

Loading

KoBeWi commented Oct 3, 2024 •

edited

Loading

KoBeWi commented Oct 3, 2024 •

edited

Loading

ydeltastar commented Oct 3, 2024 •

edited

Loading

ydeltastar Oct 4, 2024 •

edited

Loading

KoBeWi Oct 4, 2024 •

edited

Loading