From c228e31a96f25c337f1b11b639783fb43c857e8c Mon Sep 17 00:00:00 2001 From: kobewi Date: Sun, 21 Jan 2024 16:05:52 +0100 Subject: [PATCH] Clarify sizing of main screen plugins --- doc/classes/EditorInterface.xml | 1 + doc/classes/EditorPlugin.xml | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index d0de09e4512..4b1160b5f8e 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -87,6 +87,7 @@ Returns the editor control responsible for main screen plugins and tools. Use it with plugins that implement [method EditorPlugin._has_main_screen]. + [b]Note:[/b] This node is a [VBoxContainer], which means that if you add a [Control] child to it, you need to set the child's [member Control.size_flags_vertical] to [constant Control.SIZE_EXPAND_FILL] to make it use the full available space. [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 407d64e9a29..956157e8cbe 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -334,7 +334,7 @@ Returns [code]true[/code] if this is a main screen editor plugin (it goes in the workspace selector together with [b]2D[/b], [b]3D[/b], [b]Script[/b] and [b]AssetLib[/b]). - When the plugin's workspace is selected, other main screen plugins will be hidden, but your plugin will not appear automatically. It needs to be added as a child of [method EditorInterface.get_base_control] and made visible inside [method _make_visible]. + When the plugin's workspace is selected, other main screen plugins will be hidden, but your plugin will not appear automatically. It needs to be added as a child of [method EditorInterface.get_editor_main_screen] and made visible inside [method _make_visible]. Use [method _get_plugin_name] and [method _get_plugin_icon] to customize the plugin button's appearance. [codeblock] var plugin_control