EditorDebuggerPlugin — C# API

Базовый класс для реализации плагинов отладчика.

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

Базовый класс для реализации плагинов отладчика.

EditorDebuggerPlugin предоставляет функции, связанные с редакторской стороной отладчика. Для взаимодействия с отладчиком экземпляр этого класса должен быть добавлен в редактор с помощью EditorPlugin.AddDebuggerPlugin. После добавления обратный вызов EditorDebuggerPlugin._SetupSession будет вызываться для каждого EditorDebuggerSession, доступного плагину, и при создании новых (сеансы могут быть неактивны на этом этапе). Вы можете получить доступные EditorDebuggerSession с помощью EditorDebuggerPlugin.GetSessions или получить определенный с помощью EditorDebuggerPlugin.GetSession.

Для подключения на стороне запущенной игры используйте синглтон EngineDebugger:

Примечание: Во время работы игры ReckfellApi.Print и подобные функции, вызываемые в редакторе, ничего не печатают, в журнале вывода печатаются только игровые сообщения.

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

Конструкторы1

EditorDebuggerPluginКонструктор

# EditorDebuggerPlugin

C#
public EditorDebuggerPlugin();

Методы8

GetSessionEditorDebuggerSession

# GetSession

C#
public EditorDebuggerSession GetSession(int id);

Возвращает EditorDebuggerSession с указанным id.

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

Возвращает EditorDebuggerSession

GetSessionsReckfell.Collections.Array

# GetSessions

C#
public Reckfell.Collections.Array GetSessions();

Возвращает массив EditorDebuggerSession, в настоящее время доступный этому плагину отладчика. Примечание: Сеансы в массиве могут быть неактивны, проверьте их состояние с помощью EditorDebuggerSession.IsActive.

Возвращает Reckfell.Collections.Array

_BreakpointSetInTreevoid

# _BreakpointSetInTree

C#
public virtual void _BreakpointSetInTree(Script script, int line, bool enabled);

Переопределите этот метод, чтобы получать уведомления при установке точки останова в редакторе.

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

_BreakpointsClearedInTreevoid

# _BreakpointsClearedInTree

C#
public virtual void _BreakpointsClearedInTree();

Переопределите этот метод, чтобы получать уведомления об очистке всех точек останова в редакторе.

_Capturebool

# _Capture

C#
public virtual bool _Capture(string message, Reckfell.Collections.Array data, int sessionId);

Переопределите этот метод для обработки входящих сообщений. session_id — это идентификатор EditorDebuggerSession, который получил message. Используйте EditorDebuggerPlugin.GetSession для извлечения сеанса. Этот метод должен возвращать true, если сообщение распознано.

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

Возвращает bool

_GotoScriptLinevoid

# _GotoScriptLine

C#
public virtual void _GotoScriptLine(Script script, int line);

Переопределите этот метод, чтобы получать уведомления при щелчке по строке точки останова на панели точек останова отладчика.

Параметры
Имя	Тип	По умолчанию
`script`	`Script`	—
`line`	`int`	—

_HasCapturebool

# _HasCapture

C#
public virtual bool _HasCapture(string capture);

Переопределите этот метод, чтобы включить получение сообщений от отладчика. Если capture — это "my_message", то сообщения, начинающиеся с "my_message:", будут переданы методу EditorDebuggerPlugin._Capture.

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

Возвращает bool

_SetupSessionvoid

# _SetupSession

C#
public virtual void _SetupSession(int sessionId);

Переопределите этот метод, чтобы получать уведомления всякий раз, когда создается новый EditorDebuggerSession. Обратите внимание, что сеанс может быть неактивен на этом этапе.

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