EditorDebuggerPlugin

Overview ¶

EditorDebuggerPlugin provides functions related to the editor side of the debugger.

To interact with the debugger, an instance of this class must be added to the editor via EditorPlugin.AddDebuggerPlugin.

Once added, the SetupSession callback will be called for every EditorDebuggerSession available to the plugin, and when new ones are created (the sessions may be inactive during this stage).

You can retrieve the available EditorDebuggerSessions via GetSessions or get a specific one via GetSession.

package main

import (
	"fmt"

	"graphics.gd/classdb/EditorDebuggerPlugin"
	"graphics.gd/classdb/EditorPlugin"
	"graphics.gd/classdb/Label"
)

type ExampleEditorDebuggerPlugin struct {
	EditorPlugin.Extension[ExampleEditorDebuggerPlugin]

	debugger *ExampleEditorDebugger
}

func NewExampleEditorDebuggerPlugin() *ExampleEditorDebuggerPlugin {
	return &ExampleEditorDebuggerPlugin{
		debugger: new(ExampleEditorDebugger),
	}
}

func (p *ExampleEditorDebuggerPlugin) EnterTree() {
	p.AsEditorPlugin().AddDebuggerPlugin(p.debugger.AsEditorDebuggerPlugin())
}

func (p *ExampleEditorDebuggerPlugin) ExitTree() {
	p.AsEditorPlugin().RemoveDebuggerPlugin(p.debugger.AsEditorDebuggerPlugin())
}

type ExampleEditorDebugger struct {
	EditorDebuggerPlugin.Extension[ExampleEditorDebugger]
}

func (d *ExampleEditorDebugger) HasCapture(capture string) bool {
	// Return true if you wish to handle messages with the prefix "my_plugin:".
	return capture == "my_plugin"
}

func (d *ExampleEditorDebugger) Capture(message string, data []any, sessionID int) bool {
	if message == "my_plugin:ping" {
		d.AsEditorDebuggerPlugin().GetSession(sessionID).MoreArgs().SendMessage("my_plugin:echo", data)
		return true
	}
	return false
}

func (d *ExampleEditorDebugger) SetupSession(sessionID int) {
	// Add a new tab in the debugger session UI containing a label.
	var label = Label.New()
	label.AsNode().SetName("Example plugin") // Will be used as the tab title.
	label.SetText("Example plugin")
	var session = d.AsEditorDebuggerPlugin().GetSession(sessionID)
	// Listens to the session started and stopped signals.
	session.OnStarted(func() { fmt.Println("Session started") })
	session.OnStopped(func() { fmt.Println("Session stopped") })
	session.AddSessionTab(label.AsControl())
}

To connect on the running game side, use the EngineDebugger singleton:

package main

import (
	"fmt"

	"graphics.gd/classdb/EngineDebugger"
	"graphics.gd/classdb/Node"
)

type ExampleDebuggerPlugin struct {
	Node.Extension[ExampleDebuggerPlugin]
}

func (e *ExampleDebuggerPlugin) Ready() {
	EngineDebugger.RegisterMessageCapture("my_plugin", func(message string, data []any) bool {
		// Note that the "my_plugin:" prefix is not used here.
		if message == "echo" {
			fmt.Println("Echo received:", data)
			return true
		}
		return false
	})
}

Note: While the game is running, @GlobalScope.Print and similar functions called in the editor do not print anything, the Output Log prints only game messages.