Expose `ScenePaint2DEditor` by DexterFstone · Pull Request #119052 · godotengine/godot

DexterFstone · 2026-04-28T17:47:13Z

closes godotengine/godot-proposals#14730

2026-04-28.01-36-50.mp4

Methods:

EditorInterface.get_scene_paint_2d()

get_painted_scene()
set_painted_scene()
unregister_scene_provider()
register_scene_provider()

## Note:
The documentation is written by AI, my native language is not English, so I appreciate any improvements.

AThousandShips · 2026-04-28T19:10:35Z

The documentation is written by AI, my native language is not English, so I appreciate any improvements

Please do not use AI to write documentation, use translation software instead

KoBeWi

Left some comments on the API.

I think it's fine overall, but I don't get what's the paint mode exposed for.

Jordyfel · 2026-04-29T12:46:23Z

The way it is exposed conflicts with #109746. Which way should be preferred?

AThousandShips · 2026-04-30T09:18:16Z

+		Class for interacting with the 2D editor's Scene Paint Mode.
+	</brief_description>
+	<description>
+		This class is available only in editor and cannot be instantiated. Access it using [method EditorInterface.get_scene_paint_2d].


Suggested change

This class is available only in editor and cannot be instantiated. Access it using [method EditorInterface.get_scene_paint_2d].

This class is available only in the editor and cannot be instantiated. Access it using [method EditorInterface.get_scene_paint_2d].

KoBeWi

Some minor code problems left, but otherwise looks fine.

The way it is exposed conflicts with #109746. Which way should be preferred?

Well, there are 2 problems with this:

That PR is not merged yet
ScenePaint2DEditor is not a plugin (the exposed methods would need to be moved)

The reason I opened that PR was because someone exposed a plugin with no way to access it properly. Unless I missed it, no one even suggested using EditorInterface for that 😅

Then again, all classes accessible via EditorInterface are core editor components, not plugins (with the exception of ScriptEditor, which has a parent plugin). So we don't really have established way for exposing plugins. Using EditorInterface is better for discoverability at least.

KoBeWi · 2026-04-29T19:59:39Z

+		<method name="get_painted_scene" qualifiers="const">
+			<return type="Node2D" />
+			<description>
+				Returns the painted scene, or [code]null[/code] if none is selected.


You could also mention that it's possible to customize the scene's properties.

KoBeWi · 2026-04-30T11:17:35Z

+	if (!ResourceLoader::exists(p_path)) {
+		EditorNode::get_singleton()->show_accept(TTR("The selected scene could not be found. It may have been moved or deleted."), TTR("OK"));


Suggested change

if (!ResourceLoader::exists(p_path)) {

EditorNode::get_singleton()->show_accept(TTR("The selected scene could not be found. It may have been moved or deleted."), TTR("OK"));

if (!ResourceLoader::exists(p_path, "PackedScene")) {

EditorNode::get_singleton()->show_warning(TTR("The selected scene could not be found. It may have been moved or deleted."));

KoBeWi · 2026-04-30T11:21:04Z

+	Ref<SceneState> scene_state = scene->get_state();
+	String type;
+	while (scene_state.is_valid() && type.is_empty()) {
+		ERR_FAIL_COND_V(scene_state->get_node_count() < 1, nullptr);
+		type = scene_state->get_node_type(0);
+		scene_state = scene_state->get_base_scene_state();
+	}
+	ERR_FAIL_COND_V_EDMSG(type.is_empty(), nullptr, "The selected scene is invalid.");
+	bool extends_current_class = ClassDB::is_parent_class(type, "Node2D");
+	if (scene.is_valid() && extends_current_class) {
+		return Object::cast_to<Node2D>(scene->instantiate());
+	}
+	return nullptr;


This could be simplified to (not tested)

Suggested change

Ref<SceneState> scene_state = scene->get_state();

String type;

while (scene_state.is_valid() && type.is_empty()) {

ERR_FAIL_COND_V(scene_state->get_node_count() < 1, nullptr);

type = scene_state->get_node_type(0);

scene_state = scene_state->get_base_scene_state();

}

ERR_FAIL_COND_V_EDMSG(type.is_empty(), nullptr, "The selected scene is invalid.");

bool extends_current_class = ClassDB::is_parent_class(type, "Node2D");

if (scene.is_valid() && extends_current_class) {

return Object::cast_to<Node2D>(scene->instantiate());

}

return nullptr;

Node *node = scene->instantiate();

ERR_FAIL_NULL_V_EDMSG(node, nullptr, "The selected scene is invalid.");

Node2D *n2d = Object::cast_to<Node2D>(node);

if (!n2d) {

node->queue_free();

return null;

}

return n2d;

KoBeWi · 2026-04-30T11:22:45Z

+		} break;
+		case PICK_CUSTOM_SOURCE: {
+			Callable callback = custom_sources[p_control];
+			Variant result = callback.call();


You could use callp() for error handling. EditorInterface code has some examples.

KoBeWi · 2026-04-30T11:26:45Z

+void ScenePaint2DEditor::register_scene_provider(Control *p_control, const Callable &p_callback) {
+	ERR_FAIL_COND_MSG(custom_sources.has(p_control), "Provider already registered.");
+	custom_sources[p_control] = p_callback;
+	if (!p_control->is_connected(SceneStringName(gui_input), callable_mp(this, &ScenePaint2DEditor::_custom_source_input))) {


Pretty sure the condition is not needed. You already safeguard against repeated registering, so mutliple connections are not possible.

KoBeWi · 2026-04-30T11:27:27Z

+void ScenePaint2DEditor::unregister_scene_provider(Control *p_control) {
+	ERR_FAIL_COND_MSG(!custom_sources.has(p_control), "Provider not found.");
+	custom_sources.erase(p_control);
+	if (p_control->is_connected(SceneStringName(gui_input), callable_mp(this, &ScenePaint2DEditor::_custom_source_input))) {


Same here. If the source was registered before, it's guaranteed to be connected. (user meddling with signal connections is irrelevant)

KoBeWi · 2026-04-30T11:30:44Z

 		if (input_tool == INPUT_TOOL_PICK || input_tool == INPUT_TOOL_QUICK_PICK) {
 			if (mb->is_pressed() && mb->get_button_index() == MouseButton::LEFT) {
-				callable_mp(this, &ScenePaint2DEditor::_update_scene_picker).call_deferred(PICK_CANVAS_ITEM);
+				callable_mp(this, &ScenePaint2DEditor::_update_scene_picker).call_deferred(PICK_CANVAS_ITEM, (Control *)nullptr);


Is the cast needed?

DexterFstone requested review from a team as code owners April 28, 2026 17:47

DexterFstone force-pushed the Expose-ScenePaint2DEditor branch from 26bca26 to 41ebfe1 Compare April 28, 2026 18:25

DexterFstone force-pushed the Expose-ScenePaint2DEditor branch from 41ebfe1 to 4bc647d Compare April 29, 2026 07:10

AThousandShips added enhancement topic:editor topic:2d labels Apr 29, 2026

AThousandShips added this to the 4.x milestone Apr 29, 2026

KoBeWi reviewed Apr 29, 2026

View reviewed changes

DexterFstone force-pushed the Expose-ScenePaint2DEditor branch from 4bc647d to fb431dd Compare April 29, 2026 16:16

AThousandShips reviewed Apr 29, 2026

View reviewed changes

Comment thread doc/classes/ScenePaint2DEditor.xml Outdated

Expose ScenePaint2DEditor

f23b063

DexterFstone force-pushed the Expose-ScenePaint2DEditor branch from fb431dd to f23b063 Compare April 29, 2026 17:50

DexterFstone requested a review from KoBeWi April 30, 2026 06:49

AThousandShips reviewed Apr 30, 2026

View reviewed changes

KoBeWi approved these changes Apr 30, 2026

View reviewed changes

	This class is available only in editor and cannot be instantiated. Access it using [method EditorInterface.get_scene_paint_2d].
	This class is available only in the editor and cannot be instantiated. Access it using [method EditorInterface.get_scene_paint_2d].

		if (!ResourceLoader::exists(p_path)) {
		EditorNode::get_singleton()->show_accept(TTR("The selected scene could not be found. It may have been moved or deleted."), TTR("OK"));

Uh oh!

Conversation

DexterFstone commented Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Methods:

Uh oh!

AThousandShips commented Apr 28, 2026

Uh oh!

KoBeWi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Jordyfel commented Apr 29, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KoBeWi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

DexterFstone commented Apr 28, 2026 •

edited

Loading