EditorDebuggerSession — C# API

class EditorDebuggerSessionReckfellSharpEditorInherits RefCounted

A class to interact with the editor debugger.

This class cannot be directly instantiated and must be retrieved via an EditorDebuggerPlugin. You can add tabs to the session UI via EditorDebuggerSession.AddSessionTab, send messages via EditorDebuggerSession.SendMessage, and toggle EngineProfilers via EditorDebuggerSession.ToggleProfiler.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Methods8

AddSessionTabvoid

# AddSessionTab

C#
public void AddSessionTab(Control control);

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.

Parameters
Name	Type	Default
`control`	`Control`	—

IsActivebool

# IsActive

C#
public bool IsActive();

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

Returns bool

IsBreakedbool

# IsBreaked

C#
public bool IsBreaked();

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

Returns bool

IsDebuggablebool

# IsDebuggable

C#
public bool IsDebuggable();

Returns true if the attached remote instance can be debugged.

Returns bool

RemoveSessionTabvoid

# RemoveSessionTab

C#
public void RemoveSessionTab(Control control);

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

Parameters
Name	Type	Default
`control`	`Control`	—

SendMessagevoid

# SendMessage

C#
public void SendMessage(string message, Reckfell.Collections.Array data = null);

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

Parameters
Name	Type	Default
`message`	`string`	—
`data`	`Reckfell.Collections.Array`	`null`

SetBreakpointvoid

# SetBreakpoint

C#
public void SetBreakpoint(string path, int line, bool enabled);

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

Parameters
Name	Type	Default
`path`	`string`	—
`line`	`int`	—
`enabled`	`bool`	—

ToggleProfilervoid

# ToggleProfiler

C#
public void ToggleProfiler(string profiler, bool enable, Reckfell.Collections.Array data = null);

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

Parameters
Name	Type	Default
`profiler`	`string`	—
`enable`	`bool`	—
`data`	`Reckfell.Collections.Array`	`null`

Signals and events4

BreakedEvent

# Breaked

public event EditorDebuggerSession.BreakedEventHandler Breaked;

Emitted when the attached remote instance enters a break state. If can_debug is true, the remote instance will enter the debug loop.

Handler parameters
Name	Type	Default
`canDebug`	`bool`	—

ContinuedEvent

# Continued

public event Action Continued;

Emitted when the attached remote instance exits a break state.

StartedEvent

# Started

public event Action Started;

Emitted when a remote instance is attached to this session (i.e. the session becomes active).

StoppedEvent

# Stopped

public event Action Stopped;

Emitted when a remote instance is detached from this session (i.e. the session becomes inactive).