Can I use the built in class list dialog to let plugin users select a class? And how to?

Help
,
1

Godot Version

v4.6.beta3.official [76dda5c6c]

Question

In my plugin I want the user to be able to select a base class. This is the same as what is offered by the Create New Script Dialog:

image
image323×271 9.57 KB

Pressing that button brings up this dialog:

image
image448×139 2.85 KB

That dialog lists all the classes/nodes including extended node types.
I don’t relish the though of rebuilding that dialog since it already exists and works well.
I can’t find it however as a child of ScriptCreateDialog.
Is there anyway for my plugin to use this?
I would like show the dialog to hook onto what the user selects from it.

2

I looked into source code a bit and it seems that this window cannot be obtained. More precisely the window control itself can be plucked out of the scene tree panel’s ScriptCreateDialog object but the window is empty. It is only populated on the fly when shown by clicking the tree button in ScriptCreateDialog. You can check it yourself with this piece of hacky code:

var scd: ScriptCreateDialog = EditorPlugin.new().get_script_create_dialog()
scd.find_children("@Cr*", "", false, false)[0].popup_centered()

The class of this dialog is CreateDialog. It is not exposed to script. You cannot create this dialog from script. Editor’s ScriptCreateDialog object has only one direct child named @CreateDialog... so the hacky code is able to return precisely that window.

If you look at ScriptCreateDialog::_browse_class_in_tree() it calls CreateDialog::popup_create() which populates the window. This cannot be called from script. The dialog calls _cleanup() on itself when it is confirmed/canceled. This purges all of its child nodes.

In short; looks like you’ll have to build a similar dialog yourself. Or make a gdextension that exposes CreateDialog to scripting.

3 Likes
3

Thanks for looking at it.
Sadly rebuilding this is going to be complex.
ClassDB.get_class_list() returns 1500+ class definition dictionaries and not in any hierarchy.
If I go with this, I will have to work my way up the inheritance tree for each class.
I can get the custom classes using ProjectSettings.get_global_class_list() and their respective parent classes.
I’ll keep poking around to see if someone has done this already.

4

Actually you could get the callable that’s connected to ‘pressed’ signal of that tree button in ScriptCreateDialog and try to call it. It’s very hacky but maybe could work.

5

Here you go.
Warning! Some serious L33t h4xx0r code ahead :rofl:

func show_inherit_dialog():
	var scd: ScriptCreateDialog = EditorPlugin.new().get_script_create_dialog()
	scd.show()
	scd.mode = Window.MODE_MINIMIZED
	var cd = scd.find_children("@Cr*", "", false, false)[0]
	for button in scd.find_children("*", "Button", true, false):
		var connections = button.pressed.get_connections()
		if connections.is_empty():
			continue
		if connections[0]["callable"].get_method().contains("_browse_class_in_tree"):
			connections[0]["callable"].call()
			cd.canceled.connect(_on_canceled.bind(scd, cd))
			cd.confirmed.connect(_on_confirmed.bind(scd, cd))
			break

func _on_confirmed(scd, cd):
	var selected = cd.find_children("*", "Tree", true, false)[1].get_selected().get_text(0)
	print("SELECTED: %s"%selected)
	_cleanup(scd, cd)

func _on_canceled(scd, cd):
	print("CANCELED")
	_cleanup(scd, cd)

func _cleanup(scd, cd):
	cd.canceled.disconnect(_on_canceled)
	cd.confirmed.disconnect(_on_confirmed)
	scd.hide()
1 Like
6

Works perfectly. Thanks.
I see nothing hack/wrong with this method. The only thing I would say is that Godot should make it easier for plugins to access this dialog.

2 Likes
7

They should just expose CreateDialog class. You can make a feature request.

The code I posted above makes some assumptions about the scene tree structure that could change in the future versions. It could be further improved with additional error checks etc. but I tried to keep it short just as a proof of concept.

The only real annoyance here is that the ScriptCreateDialog window must be kept open. It could be re-positioned out of the visible area but that’d be even more hacky. I just minimized it. It still by far beats recreating the whole thing manually.

8

I submitted a feature proposal in discussions here.

2 Likes
9

The opened `CreateDialog` show “Node” as root class (since it’s in "attach script to node” mode), thought I’d like for it to show Object.
I’ve tried
var scd: ScriptCreateDialog = EditorPlugin.new().get_script_create_dialog()
scd.config(
“Object”,
“res://new_resource.tres”,
)
scd.popup_centered()

But it doesn’t seem to work.