EditorDebuggerSession

Documentation

Overview

Package EditorDebuggerSession provides methods for working with EditorDebuggerSession object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AddSessionTab(control [1]gdclass.Control)
  • func (self Instance) AsEditorDebuggerSession() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) IsActive() bool
  • func (self Instance) IsBreaked() bool
  • func (self Instance) IsDebuggable() bool
  • func (self Instance) OnBreaked(cb func(can_debug bool))
  • func (self Instance) OnContinued(cb func())
  • func (self Instance) OnStarted(cb func())
  • func (self Instance) OnStopped(cb func())
  • func (self Instance) RemoveSessionTab(control [1]gdclass.Control)
  • func (self Instance) SendMessage(message string)
  • func (self Instance) SetBreakpoint(path string, line int, enabled bool)
  • func (self Instance) ToggleProfiler(profiler string, enable bool)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

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 Instance

type Instance [1]gdclass.EditorDebuggerSession

This class cannot be directly instantiated and must be retrieved via a [EditorDebuggerPlugin]. You can add tabs to the session UI via [method add_session_tab], send messages via [method send_message], and toggle [EngineProfiler]s via [method toggle_profiler].

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 [1]gdclass.Control)

Adds the given [param control] to the debug session UI in the debugger bottom panel. The [param 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) IsActive

func (self Instance) IsActive() bool

Returns [code]true[/code] if the debug session is currently attached to a remote instance.

func (Instance) IsBreaked

func (self Instance) IsBreaked() bool

Returns [code]true[/code] if the attached remote instance is currently in the debug loop.

func (Instance) IsDebuggable

func (self Instance) IsDebuggable() bool

Returns [code]true[/code] if the attached remote instance can be debugged.

func (Instance) OnBreaked

func (self Instance) OnBreaked(cb func(can_debug bool))

func (Instance) OnContinued

func (self Instance) OnContinued(cb func())

func (Instance) OnStarted

func (self Instance) OnStarted(cb func())

func (Instance) OnStopped

func (self Instance) OnStopped(cb func())

func (Instance) RemoveSessionTab

func (self Instance) RemoveSessionTab(control [1]gdclass.Control)

Removes the given [param control] from the debug session UI in the debugger bottom panel.

func (Instance) SendMessage

func (self Instance) SendMessage(message string)

Sends the given [param message] to the attached remote instance, optionally passing additionally [param data]. See [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 [param enabled], updating the Editor Breakpoint Panel accordingly.

func (Instance) ToggleProfiler

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

Toggle the given [param profiler] on the attached remote instance, optionally passing additionally [param data]. See [EngineProfiler] for more details.

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

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