Index of every page on this site: llms.txt
All skills
jame581 avatar

/addon-development

@426e8ab
by Jan Mesarčjame581/godotprompter979 stars
63
Run it yourself

Use when creating Godot editor plugins — EditorPlugin, @tool scripts, custom inspectors, and dock panels

Use this Skill: https://skilld.dev/gh/jame581/godotprompter/addon-development

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

referencesdock-panels.md

≈2.5k tokens on demand. Your agent reads this file only when SKILL.md points to it.

Custom Dock Panels

Reference for skills/addon-development/SKILL.md — adding a custom dock to the editor (GDScript and C#).

← Back to SKILL.md


5. Custom Dock Panel

Docks are Control-based scenes added to one of the editor's dock slots. Add the control in _enter_tree() and remove it in _exit_tree().

GDScript

# plugin.gd
@tool
extends EditorPlugin

var _dock: Control


func _enter_tree() -> void:
    # Load a scene or instantiate a Control directly.
    _dock = preload("res://addons/my_plugin/my_dock.tscn").instantiate()

    # DOCK_SLOT_LEFT_UL = upper slot of the far-left column (empty by default;
    # Scene/Import sit in DOCK_SLOT_LEFT_UR). See the slot table below.
    add_control_to_dock(DOCK_SLOT_LEFT_UL, _dock)


func _exit_tree() -> void:
    if _dock:
        remove_control_from_docks(_dock)
        _dock.queue_free()
        _dock = null

C#

#if TOOLS
using Godot;

[Tool]
public partial class MyPlugin : EditorPlugin
{
    private Control _dock;

    public override void _EnterTree()
    {
        _dock = GD.Load<PackedScene>("res://addons/my_plugin/MyDock.tscn").Instantiate<Control>();
        AddControlToDock(DockSlot.LeftUl, _dock);
    }

    public override void _ExitTree()
    {
        if (_dock != null)
        {
            RemoveControlFromDocks(_dock);
            _dock.QueueFree();
            _dock = null;
        }
    }
}
#endif

Godot 4.6+: EditorDock and add_dock

add_control_to_dock is deprecated in Godot 4.6 (the class reference marks it "Use add_dock instead"). The replacement, EditorPlugin.add_dock(dock: EditorDock), does not exist in 4.3 to 4.5, so the example above stays the right code for those versions. EditorDock is a container (marked experimental in 4.6 to 4.8) with title, dock_icon, default_slot, available_layouts and closable; remove it with remove_dock(dock).

To support 4.3 and 4.6+ from one plugin, branch on the engine version. The GDScript below is untyped on purpose: it must still parse on 4.3, where EditorDock and add_dock are unknown identifiers.

# plugin.gd
@tool
extends EditorPlugin

var _dock: Control
var _use_editor_dock := false


func _enter_tree() -> void:
    var content: Control = preload("res://addons/my_plugin/my_dock.tscn").instantiate()
    _use_editor_dock = Engine.get_version_info().hex >= 0x040600
    if _use_editor_dock:
        var dock = ClassDB.instantiate("EditorDock")
        dock.title = "My Dock"
        dock.default_slot = DOCK_SLOT_LEFT_UL  # EditorPlugin's constant, same value (0) as EditorDock.DOCK_SLOT_LEFT_UL;
        # a literal `EditorDock.` reference would not parse on 4.3
        dock.add_child(content)
        call("add_dock", dock)
        _dock = dock
    else:
        _dock = content
        add_control_to_dock(DOCK_SLOT_LEFT_UL, _dock)


func _exit_tree() -> void:
    if _dock:
        if _use_editor_dock:
            call("remove_dock", _dock)
        else:
            remove_control_from_docks(_dock)
        _dock.queue_free()
        _dock = null

In C# the bindings you compile against decide: a project on Godot.NET.Sdk 4.6 or newer has EditorDock, an older one does not. On 4.3 to 4.5 bindings keep the AddControlToDock example above; ship the typed 4.6+ variant below only when the plugin's minimum is 4.6. To support both from one assembly, use the untyped cross-version variant after it.

#if TOOLS
using Godot;

[Tool]
public partial class MyPlugin : EditorPlugin
{
    private EditorDock _dock;

    public override void _EnterTree()
    {
        _dock = new EditorDock
        {
            Title = "My Dock",
            DefaultSlot = EditorDock.DockSlot.LeftUl,
        };
        _dock.AddChild(GD.Load<PackedScene>("res://addons/my_plugin/MyDock.tscn").Instantiate<Control>());
        AddDock(_dock);
    }

    public override void _ExitTree()
    {
        if (_dock != null)
        {
            RemoveDock(_dock);
            _dock.QueueFree();
            _dock = null;
        }
    }
}
#endif

Cross-version C# (compiles against any bindings; EditorDock and add_dock are reached by name at runtime):

#if TOOLS
using Godot;

[Tool]
public partial class MyPlugin : EditorPlugin
{
    private Control _dock;
    private bool _useEditorDock;

    public override void _EnterTree()
    {
        var content = GD.Load<PackedScene>("res://addons/my_plugin/MyDock.tscn").Instantiate<Control>();
        var v = Engine.GetVersionInfo();
        _useEditorDock = (int)v["hex"] >= 0x040600;
        if (_useEditorDock)
        {
            _dock = (Control)ClassDB.Instantiate("EditorDock").AsGodotObject();
            _dock.Set("title", "My Dock");
            _dock.Set("default_slot", 0); // EditorDock.DOCK_SLOT_LEFT_UL
            _dock.AddChild(content);
            Call("add_dock", _dock);
        }
        else
        {
            _dock = content;
            AddControlToDock(DockSlot.LeftUl, _dock);
        }
    }

    public override void _ExitTree()
    {
        if (_dock != null)
        {
            if (_useEditorDock) Call("remove_dock", _dock);
            else RemoveControlFromDocks(_dock);
            _dock.QueueFree();
            _dock = null;
        }
    }
}
#endif

Creating the dock scene:

  1. Create a new scene with a Control (or VBoxContainer, PanelContainer, etc.) as root.
  2. Set the scene root's Custom Minimum Size so the dock has a sensible default size.
  3. Add any UI controls (buttons, labels, trees) as children.
  4. Save as my_dock.tscn inside your plugin folder.

Available dock slots:

Constant Location
DOCK_SLOT_LEFT_UL / DOCK_SLOT_LEFT_BL Far-left column, upper / lower (empty by default)
DOCK_SLOT_LEFT_UR / DOCK_SLOT_LEFT_BR Second-left column, upper (Scene / Import) / lower (FileSystem)
DOCK_SLOT_RIGHT_UL / DOCK_SLOT_RIGHT_BL First right column, upper (Inspector / Node) / lower
DOCK_SLOT_RIGHT_UR / DOCK_SLOT_RIGHT_BR Far-right column, upper / lower (empty by default)

Main-Screen Plugins (Changed in Godot 4.8)

In Godot 4.8 the main screens (2D, 3D, Script, Game, Asset Store) are docks. A main-screen plugin is now an EditorDock (still experimental in 4.8) whose default_slot is EditorDock.DOCK_SLOT_MAIN_SCREEN (11) and whose available_layouts include EditorDock.DOCK_LAYOUT_MAIN_SCREEN (8); the tab shows its title and dock_icon. Deprecated in 4.8:

  • EditorPlugin._has_main_screen() and _get_plugin_icon(): use add_dock() with such a dock.
  • EditorInterface.get_editor_main_screen(): it no longer returns the real main screen, only a container kept for legacy plugins.
  • EditorInterface.set_main_screen_editor(name): use get_dock_by_name(name) and EditorDock.make_visible().

The 4.3 to 4.7 pattern (_has_main_screen() returns true, _enter_tree() adds a panel to get_editor_main_screen(), _make_visible() shows and hides it) keeps working on 4.8 through a compatibility container that wraps the panel in a main-screen dock named by _get_plugin_name(). It wraps only a child added while the plugin enters the tree, between NOTIFICATION_ENTER_TREE and NOTIFICATION_POST_ENTER_TREE; a panel added in _init() or deferred is not wrapped (the draft 4.8 migration guide: only "the most standard way" is supported).

One plugin for 4.3 to 4.8 branches on the version. As above, EditorDock names stay out of the source so it parses on 4.3:

# plugin.gd: main-screen plugin
@tool
extends EditorPlugin

var _panel: Control
var _dock: Control  # EditorDock on 4.8+
var _use_dock: bool = Engine.get_version_info().hex >= 0x040800


func _enter_tree() -> void:
    _panel = preload("res://addons/my_plugin/main_panel.tscn").instantiate()
    if _use_dock:
        _dock = ClassDB.instantiate("EditorDock")
        _dock.set("title", _get_plugin_name())
        _dock.set("default_slot", 11)  # EditorDock.DOCK_SLOT_MAIN_SCREEN
        _dock.set("available_layouts", 8)  # EditorDock.DOCK_LAYOUT_MAIN_SCREEN
        _dock.add_child(_panel)
        call("add_dock", _dock)
    else:
        EditorInterface.get_editor_main_screen().add_child(_panel)
        _make_visible(false)


func _exit_tree() -> void:
    if _use_dock:
        call("remove_dock", _dock)
        _dock.queue_free()  # frees _panel with it
    elif _panel:
        _panel.queue_free()
    _dock = null
    _panel = null


func _has_main_screen() -> bool:
    return not _use_dock  # deprecated on 4.8: the dock replaces it


func _make_visible(visible: bool) -> void:
    if _panel and not _use_dock:
        _panel.visible = visible


func _get_plugin_name() -> String:
    return "My Screen"

In C#, EditorDock.DockSlot.MainScreen and EditorDock.DockLayout.MainScreen exist only in Godot.NET.Sdk 4.8 bindings. A plugin whose minimum is 4.8 writes the typed dock; on older bindings keep _HasMainScreen(), which still works on 4.8 through the same compatibility container.

// Plugin.cs, Godot.NET.Sdk 4.8+
#if TOOLS
using Godot;

[Tool]
public partial class MyScreenPlugin : EditorPlugin
{
    private EditorDock _dock;

    public override void _EnterTree()
    {
        _dock = new EditorDock
        {
            Title = "My Screen",
            DefaultSlot = EditorDock.DockSlot.MainScreen,
            AvailableLayouts = EditorDock.DockLayout.MainScreen,
        };
        _dock.AddChild(GD.Load<PackedScene>("res://addons/my_plugin/MainPanel.tscn").Instantiate<Control>());
        AddDock(_dock);
    }

    public override void _ExitTree()
    {
        if (_dock != null)
        {
            RemoveDock(_dock);
            _dock.QueueFree();
            _dock = null;
        }
    }
}
#endif

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 alert7d3 checks · Risk SAFE
  • Gen Agent Trust Hub7d

    This skill provides documentation and code templates for developing Godot editor plugins in GDScript and C#. The analysis found no evidence of malicious patterns, obfuscation, or unauthorized data access.

  • Socket7d

    No alerts

  • Snyk7d

    Risk: CRITICAL · 1 issue

Signed by skilld at 426e8ab. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 6 days ago.

Activeupdated last week

README badge

README badge for jame581/godotprompter/addon-development