Skip to content

Commit 810180f

Browse files
committed
Update EditorDock shortcut documentation
1 parent d743736 commit 810180f

2 files changed

Lines changed: 3 additions & 2 deletions

File tree

doc/classes/EditorDock.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@
9696
The icon for the dock, as a texture. If specified, it will override [member icon_name].
9797
</member>
9898
<member name="dock_shortcut" type="Shortcut" setter="set_dock_shortcut" getter="get_dock_shortcut">
99-
The shortcut used to open the dock. This property can only be set before this dock is added via [method EditorPlugin.add_dock].
99+
The shortcut used to open the dock.
100100
</member>
101101
<member name="force_show_icon" type="bool" setter="set_force_show_icon" getter="get_force_show_icon" default="false">
102102
If [code]true[/code], the dock will always display an icon, regardless of [member EditorSettings.interface/editor/dock_tab_style] or [member EditorSettings.interface/editor/bottom_dock_tab_style].

doc/classes/EditorPlugin.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,8 @@
431431
<param index="2" name="shortcut" type="Shortcut" default="null" />
432432
<description>
433433
Adds a control to the bottom panel (together with Output, Debug, Animation, etc.). Returns a reference to a button that is outside the scene tree. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [method Node.queue_free].
434-
Optionally, you can specify a shortcut parameter. When pressed, this shortcut will toggle the bottom panel's visibility. See the default editor bottom panel shortcuts in the Editor Settings for inspiration. Per convention, they all use [kbd]Alt[/kbd] modifier.
434+
[param shortcut] is a shortcut that, when activated, will toggle the bottom panel's visibility. The shortcut object is only set when this control is added to the bottom panel.
435+
[b]Note[/b] See the default editor bottom panel shortcuts in the Editor Settings for inspiration. By convention, they all use [kbd]Alt[/kbd] modifier.
435436
</description>
436437
</method>
437438
<method name="add_control_to_container">

0 commit comments

Comments
 (0)