EditorDebuggerSession

package
v0.0.0-...-e1beaa7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 16, 2025 License: MIT Imports: 23 Imported by: 0

Documentation

Overview

This class cannot be directly instantiated and must be retrieved via an graphics.gd/classdb/EditorDebuggerPlugin.

You can add tabs to the session UI via Instance.AddSessionTab, send messages via Instance.SendMessage, and toggle [graphics.gd/classdb/EngineProfiler]s via Instance.ToggleProfiler.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsEditorDebuggerSession() Instance
}

type Expanded

type Expanded [1]gdclass.EditorDebuggerSession

func (Expanded) SendMessage

func (self Expanded) SendMessage(message string, data []any)

Sends the given 'message' to the attached remote instance, optionally passing additionally 'data'. See graphics.gd/classdb/EngineDebugger for how to retrieve those messages.

func (Expanded) ToggleProfiler

func (self Expanded) ToggleProfiler(profiler string, enable bool, data []any)

Toggle the given 'profiler' on the attached remote instance, optionally passing additionally 'data'. See graphics.gd/classdb/EngineProfiler for more details.

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsEditorDebuggerSession

func (self *Extension[T]) AsEditorDebuggerSession() Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.EditorDebuggerSession

Instance of the class with convieniently typed arguments and results.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AddSessionTab

func (self Instance) AddSessionTab(control Control.Instance)

Adds the given 'control' to the debug session UI in the debugger bottom panel. The 'control”s node name will be used as the tab title.

func (Instance) AsEditorDebuggerSession

func (self Instance) AsEditorDebuggerSession() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) ID

func (self Instance) ID() ID

func (Instance) IsActive

func (self Instance) IsActive() bool

Returns true if the debug session is currently attached to a remote instance.

func (Instance) IsBreaked

func (self Instance) IsBreaked() bool

Returns true if the attached remote instance is currently in the debug loop.

func (Instance) IsDebuggable

func (self Instance) IsDebuggable() bool

Returns true if the attached remote instance can be debugged.

func (Instance) OnBreaked

func (self Instance) OnBreaked(cb func(can_debug bool), flags ...Signal.Flags)

func (Instance) OnContinued

func (self Instance) OnContinued(cb func(), flags ...Signal.Flags)

func (Instance) OnStarted

func (self Instance) OnStarted(cb func(), flags ...Signal.Flags)

func (Instance) OnStopped

func (self Instance) OnStopped(cb func(), flags ...Signal.Flags)

func (Instance) RemoveSessionTab

func (self Instance) RemoveSessionTab(control Control.Instance)

Removes the given 'control' from the debug session UI in the debugger bottom panel.

func (Instance) SendMessage

func (self Instance) SendMessage(message string)

Sends the given 'message' to the attached remote instance, optionally passing additionally 'data'. See graphics.gd/classdb/EngineDebugger for how to retrieve those messages.

func (Instance) SetBreakpoint

func (self Instance) SetBreakpoint(path string, line int, enabled bool)

Enables or disables a specific breakpoint based on 'enabled', updating the Editor Breakpoint Panel accordingly.

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) ToggleProfiler

func (self Instance) ToggleProfiler(profiler string, enable bool)

Toggle the given 'profiler' on the attached remote instance, optionally passing additionally 'data'. See graphics.gd/classdb/EngineProfiler for more details.

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL