Dockable container for the editor.
EditorDock is a Container node that can be docked in one of the editor's dock slots. Docks are added by plugins to provide space for controls related to an EditorPlugin. The editor comes with a few built-in docks, such as the Scene dock, FileSystem dock, etc.
You can add a dock by using EditorPlugin.add_dock(). The dock can be customized by changing its properties.
@tool
extends EditorPlugin
# Dock reference.
var dock
# Plugin initialization.
func _enter_tree():
dock = EditorDock.new()
dock.title = "My Dock"
dock.dock_icon = preload("./dock_icon.png")
dock.default_slot = EditorDock.DOCK_SLOT_RIGHT_UL
var dock_content = preload("./dock_content.tscn").instantiate()
dock.add_child(dock_content)
add_dock(dock)
# Plugin clean-up.
func _exit_tree():
remove_dock(dock)
dock.queue_free()
dock = nullThe available layouts for this dock, as a bitmask. By default, the dock allows vertical and floating layouts.
If true, the dock can be closed with the Close button in the context popup. Docks with global enabled are always closable.
The default dock slot used when adding the dock with EditorPlugin.add_dock().
After the dock is added, it can be moved to a different slot and the editor will automatically remember its position between sessions. If you remove and re-add the dock, it will be reset to default.
The icon for the dock, as a texture. If specified, it will override icon_name.
If true, the dock will always display an icon, regardless of EditorSettings.interface/editor/docks/dock_tab_style or EditorSettings.interface/editor/docks/bottom_dock_tab_style.
The icon for the dock, as a name from the EditorIcons theme type in the editor theme. You can find the list of available icons here.
The key representing this dock in the editor's layout file. If empty, the dock's displayed name will be used instead.
The title of the dock's tab. If empty, the dock's Node.name will be used. If the name is auto-generated (contains @), the first child's name will be used instead.
If true, the dock is not automatically opened or closed when loading an editor layout, only moved. It also can't be opened using a shortcut. This is meant for docks that are opened and closed in specific cases, such as when selecting a TileMap or AnimationTree node.
Implement this method to handle loading this dock's layout. It's equivalent to EditorPlugin._set_window_layout(). section is a unique section based on layout_key.
Implement this method to handle saving this dock's layout. It's equivalent to EditorPlugin._get_window_layout(). section is a unique section based on layout_key.
Implement this method to handle the layout switching for this dock. layout is one of the DockLayout constants.
func _update_layout(layout):
box_container.vertical = (layout == DOCK_LAYOUT_VERTICAL)Focuses the dock's tab (or window if it's floating). If the dock was closed, it will be opened. If it's a bottom dock, makes the bottom panel visible.
Opens the dock. It will appear in the last used dock slot. If the dock has no default slot, it will be opened floating.
Note: This does not focus the dock. If you want to open and focus the dock, use make_visible().
Emitted when the dock is closed with the Close button in the context popup, before it's removed from its parent. See closable.
Emitted when the dock is opened via the Editor > Editor Docks menu, before it's made visible.
DOCK_LAYOUT_VERTICAL = 1Allows placing the dock in the vertical dock slots on either side of the editor.
DOCK_LAYOUT_HORIZONTAL = 2Allows placing the dock in the horizontal dock slots at the bottom.
DOCK_LAYOUT_FLOATING = 4Allows making the dock floating (opened as a separate window).
DOCK_LAYOUT_ALL = 7Allows placing the dock in all available slots.
DOCK_SLOT_NONE = -1The dock is closed.
DOCK_SLOT_LEFT_UL = 0Dock slot, left side, upper-left (empty in default layout).
DOCK_SLOT_LEFT_BL = 1Dock slot, left side, bottom-left (empty in default layout).
DOCK_SLOT_LEFT_UR = 2Dock slot, left side, upper-right (in default layout includes Scene and Import docks).
DOCK_SLOT_LEFT_BR = 3Dock slot, left side, bottom-right (in default layout includes FileSystem and History docks).
DOCK_SLOT_RIGHT_UL = 4Dock slot, right side, upper-left (in default layout includes Inspector, Signal, and Group docks).
DOCK_SLOT_RIGHT_BL = 5Dock slot, right side, bottom-left (empty in default layout).
DOCK_SLOT_RIGHT_UR = 6Dock slot, right side, upper-right (empty in default layout).
DOCK_SLOT_RIGHT_BR = 7Dock slot, right side, bottom-right (empty in default layout).
DOCK_SLOT_BOTTOM = 8Bottom panel.
DOCK_SLOT_BOTTOM_L = 9Dock slot at the bottom, below bottom panel, on the left side.
DOCK_SLOT_BOTTOM_R = 10Dock slot at the bottom, below bottom panel, on the right side.
DOCK_SLOT_MAX = 11Represents the size of the DockSlot enum.