diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2024-01-29 13:17:05 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2024-01-29 13:17:05 +0100 |
| commit | 68957d29442413e26857c1d41e8565209e619d5d (patch) | |
| tree | 9327a9152c408b8993e0b066ce6bf2146d505da8 | |
| parent | c1dbaa73a6e0935a3abc31584d35063e543536b0 (diff) | |
| parent | c228e31a96f25c337f1b11b639783fb43c857e8c (diff) | |
| download | redot-engine-68957d29442413e26857c1d41e8565209e619d5d.tar.gz | |
Merge pull request #87445 from KoBeWi/expand_the_Control_empire
Clarify sizing of main screen plugins
| -rw-r--r-- | doc/classes/EditorInterface.xml | 1 | ||||
| -rw-r--r-- | doc/classes/EditorPlugin.xml | 2 |
2 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index fc28622fdb..94bb91d805 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -87,6 +87,7 @@ <return type="VBoxContainer" /> <description> 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. </description> </method> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 407d64e9a2..956157e8cb 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -334,7 +334,7 @@ <return type="bool" /> <description> 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 |