Documentation
¶
Overview ¶
This class cannot be directly instantiated and must be retrieved via an EditorDebuggerPlugin.
You can add tabs to the session UI via AddSessionTab, send messages via SendMessage, and toggle EngineProfilers via ToggleProfiler.
Index ¶
- type Advanced
- type Any
- type Expanded
- type Extension
- type ID
- type Instance
- func (self Instance) AddSessionTab(control Control.Instance)
- func (self Instance) AsEditorDebuggerSession() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) ID() ID
- func (self Instance) IsActive() bool
- func (self Instance) IsBreaked() bool
- func (self Instance) IsDebuggable() bool
- func (self Instance) MoreArgs() MoreArgs
- func (self Instance) OnBreaked(cb func(can_debug bool), flags ...Signal.Flags)
- func (self Instance) OnContinued(cb func(), flags ...Signal.Flags)
- func (self Instance) OnStarted(cb func(), flags ...Signal.Flags)
- func (self Instance) OnStopped(cb func(), flags ...Signal.Flags)
- func (self Instance) RemoveSessionTab(control Control.Instance)
- func (self Instance) SendMessage(message string)
- func (self Instance) SetBreakpoint(path string, line int, enabled bool)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) ToggleProfiler(profiler string, enable bool)
- func (self Instance) Virtual(name string) reflect.Value
- type MoreArgs
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 Extension ¶
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 (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
type 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.
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 (Instance) AddSessionTab ¶
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 (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) IsActive ¶
Returns true if the debug session is currently attached to a remote instance.
func (Instance) IsBreaked ¶
Returns true if the attached remote instance is currently in the debug loop.
func (Instance) IsDebuggable ¶
Returns true if the attached remote instance can be debugged.
func (Instance) MoreArgs ¶
MoreArgs enables certain functions to be called with additional 'optional' arguments.
func (Instance) OnBreaked ¶
Emitted when the attached remote instance enters a break state. If 'can_debug' is true, the remote instance will enter the debug loop.
func (Instance) OnContinued ¶
Emitted when the attached remote instance exits a break state.
func (Instance) OnStarted ¶
Emitted when a remote instance is attached to this session (i.e. the session becomes active).
func (Instance) OnStopped ¶
Emitted when a remote instance is detached from this session (i.e. the session becomes inactive).
func (Instance) RemoveSessionTab ¶
Removes the given 'control' from the debug session UI in the debugger bottom panel.
func (Instance) SendMessage ¶
Sends the given 'message' to the attached remote instance, optionally passing additionally 'data'. See EngineDebugger for how to retrieve those messages.
func (Instance) SetBreakpoint ¶
Enables or disables a specific breakpoint based on 'enabled', updating the Editor Breakpoint Panel accordingly.
func (Instance) ToggleProfiler ¶
Toggle the given 'profiler' on the attached remote instance, optionally passing additionally 'data'. See EngineProfiler for more details.
type MoreArgs ¶
type MoreArgs [1]gdclass.EditorDebuggerSession
MoreArgs is a container for Instance functions with additional 'optional' arguments.
func (MoreArgs) SendMessage ¶
Sends the given 'message' to the attached remote instance, optionally passing additionally 'data'. See EngineDebugger for how to retrieve those messages.
func (MoreArgs) ToggleProfiler ¶
Toggle the given 'profiler' on the attached remote instance, optionally passing additionally 'data'. See EngineProfiler for more details.
Source Files