EditorDebuggerSession — C# API

Класс для взаимодействия с отладчиком редактора.

class EditorDebuggerSessionReckfellSharpEditorНаследует RefCounted

Класс для взаимодействия с отладчиком редактора.

Этот класс нельзя создать напрямую, и его необходимо получить через EditorDebuggerPlugin. Вы можете добавлять вкладки в пользовательский интерфейс сеанса с помощью EditorDebuggerSession.AddSessionTab, отправлять сообщения с помощью EditorDebuggerSession.SendMessage и переключать EngineProfiler с помощью EditorDebuggerSession.ToggleProfiler.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Методы8

AddSessionTabvoid

# AddSessionTab

C#
public void AddSessionTab(Control control);

Добавляет заданный control в пользовательский интерфейс сеанса отладки на нижней панели отладчика. Имя узла control будет использоваться в качестве заголовка вкладки.

Параметры
Имя	Тип	По умолчанию
`control`	`Control`	—

IsActivebool

# IsActive

C#
public bool IsActive();

Возвращает true, если сеанс отладки в данный момент подключен к удаленному экземпляру.

Возвращает bool

IsBreakedbool

# IsBreaked

C#
public bool IsBreaked();

Возвращает true, если присоединенный удаленный экземпляр в данный момент находится в цикле отладки.

Возвращает bool

IsDebuggablebool

# IsDebuggable

C#
public bool IsDebuggable();

Возвращает true, если присоединенный удаленный экземпляр может быть отлажен.

Возвращает bool

RemoveSessionTabvoid

# RemoveSessionTab

C#
public void RemoveSessionTab(Control control);

Удаляет указанный control из пользовательского интерфейса сеанса отладки на нижней панели отладчика.

Параметры
Имя	Тип	По умолчанию
`control`	`Control`	—

SendMessagevoid

# SendMessage

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

Отправляет указанное message на подключенный удаленный экземпляр, опционально передавая дополнительно data. См. EngineDebugger для получения этих сообщений.

Параметры
Имя	Тип	По умолчанию
`message`	`string`	—
`data`	`Reckfell.Collections.Array`	`null`

SetBreakpointvoid

# SetBreakpoint

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

Включает или отключает конкретную точку перелома на основе enabled, обновление редактора Panel Соответственно.

Параметры
Имя	Тип	По умолчанию
`path`	`string`	—
`line`	`int`	—
`enabled`	`bool`	—

ToggleProfilervoid

# ToggleProfiler

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

Переключить заданный profiler на подключенном удаленном экземпляре, опционально передавая дополнительно data. Подробнее см. EngineProfiler.

Параметры
Имя	Тип	По умолчанию
`profiler`	`string`	—
`enable`	`bool`	—
`data`	`Reckfell.Collections.Array`	`null`

Сигналы и события4

BreakedСобытие

# Breaked

public event EditorDebuggerSession.BreakedEventHandler Breaked;

Вызывается, когда присоединенный удаленный экземпляр входит в состояние останова. Если can_debug равен true, удаленный экземпляр войдет в цикл отладки.

Параметры обработчика
Имя	Тип	По умолчанию
`canDebug`	`bool`	—

ContinuedСобытие

# Continued

public event Action Continued;

Вызывается, когда подключенный удаленный экземпляр выходит из состояния останова.

StartedСобытие

# Started

public event Action Started;

Генерируется, когда к данному сеансу присоединяется удаленный экземпляр (т.е. сеанс становится активным).

StoppedСобытие

# Stopped

public event Action Stopped;

Генерируется, когда удаленный экземпляр отключается от данного сеанса (т. е. сеанс становится неактивным).