reckfellENGINE

ScriptEditor

Панель открытых внутренних документов и встроенной справки.

На этой странице
class ScriptEditorReckfellSharpEditorНаследует EditorDock

Получайте экземпляр через EditorInterface.Singleton.GetScriptEditor(). Список документов, активный ресурс Script и вкладка справки — разные понятия: справка не является Script/ScriptEditorBase. GetCurrentScript() и GetCurrentEditor() могут вернуть null.

GetOpenScripts() и GetUnsavedFiles() относятся к внутренним документам, не ко всему проекту и не к буферам внешней IDE. Для C# контекст проекта, компиляция и отладка настраиваются отдельно.

Работа с панелью Script.

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

Методы16

ClearDocsFromScriptvoid
# ClearDocsFromScript
C#
public void ClearDocsFromScript(Script script);

Удаляет документацию для указанного script. Примечание: Этот вызов следует выполнять при каждом изменении скрипта, чтобы поддерживать состояние открытой документации в актуальном состоянии.

Параметры
ИмяТипПо умолчанию
scriptScript—
CloseFileError
# CloseFile
C#
public Error CloseFile(string path);

Закрывает файл по заданному path, отбрасывая все несохранённые изменения. Возвращает OK в случае успеха или ERR_FILE_NOT_FOUND, если файл не найден.

Параметры
ИмяТипПо умолчанию
pathstring—
Возвращает Error
GetBreakpointsstring[]
# GetBreakpoints
C#
public string[] GetBreakpoints();

Возвращает массив точек останова.

Возвращает string[]
GetCurrentEditorScriptEditorBase
# GetCurrentEditor
C#
public ScriptEditorBase GetCurrentEditor();

Возвращает текущий ScriptEditorBase, если активный документ относится к этому типу. Вкладка справки им не является; результат может быть null. Это не получение внешнего редактора процесса.

Возвращает ScriptEditorBase

Текущий ScriptEditorBase или null.

GetCurrentScriptScript
# GetCurrentScript
C#
public Script GetCurrentScript();

Возвращает Script активного внутреннего редактора. На вкладке справки или при отсутствии подходящего документа возвращает null. Не определяет активный файл внешней C#-IDE.

Возвращает Script

Ресурс Script или null.

GetOpenScriptEditorsReckfell.Collections.Array<ScriptEditorBase>
# GetOpenScriptEditors
C#
public Reckfell.Collections.Array<ScriptEditorBase> GetOpenScriptEditors();

Возвращает массив со всеми объектами ScriptEditorBase, которые в данный момент открыты в редакторе.

Возвращает Reckfell.Collections.Array<ScriptEditorBase>
GetOpenScriptsReckfell.Collections.Array<Script>
# GetOpenScripts
C#
public Reckfell.Collections.Array<Script> GetOpenScripts();

Перечисляет открытые ресурсы Script во внутренних документах. Справка и произвольные текстовые файлы не становятся скриптами; это не индекс всех файлов проекта или документов внешней IDE.

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

Массив открытых Script.

GetUnsavedFilesstring[]
# GetUnsavedFiles
C#
public string[] GetUnsavedFiles();

Перечисляет пути внутренних документов с несохранённым буфером. Не учитывает несохранённый текст внешней IDE и не подтверждает, что вся сцена или проект сохранены.

Возвращает string[]

Пути документов, которые внутренний редактор считает несохранёнными.

GotoHelpvoid
# GotoHelp
C#
public void GotoHelp(string topic);

Открывает встроенный документ справки по описателю, например class_name:Entity. Это не открытие Script и не выбор внешней C#-IDE; после перехода GetCurrentScript() может вернуть null.

Параметры
ИмяТипПо умолчанию
topicstring—
topic

Описатель темы справки; для проверенного примера class_name:Entity.

GotoLinevoid
# GotoLine
C#
public void GotoLine(int lineNumber);

Переход к указанной строке текущего скрипта.

Параметры
ИмяТипПо умолчанию
lineNumberint—
OpenScriptCreateDialogvoid
# OpenScriptCreateDialog
C#
public void OpenScriptCreateDialog(string baseName, string basePath);

Открывает диалог создания скрипта. Скрипт будет расширять base_name. Расширение файла может быть опущено в base_path. Оно будет добавлено на основе выбранного языка скрипта.

Параметры
ИмяТипПо умолчанию
baseNamestring—
basePathstring—
RegisterSyntaxHighlightervoid
# RegisterSyntaxHighlighter
C#
public void RegisterSyntaxHighlighter(EditorSyntaxHighlighter syntaxHighlighter);

Регистрирует EditorSyntaxHighlighter в редакторе, EditorSyntaxHighlighter будет доступен во всех открытых скриптах. Примечание: Не применяется к уже открытым скриптам.

Параметры
ИмяТипПо умолчанию
syntaxHighlighterEditorSyntaxHighlighter—
ReloadOpenFilesvoid
# ReloadOpenFiles
C#
public void ReloadOpenFiles();

Перезагружает все файлы, которые открыты на данный момент. Это должно быть использовано когда открытые файлы изменились снаружи редактора скриптов. Пользователю может быть предложено решить конфликты с файлами, см. EditorSettings.text_editor/behavior/files/auto_reload_scripts_on_external_change.

SaveAllScriptsvoid
# SaveAllScripts
C#
public void SaveAllScripts();

Сохраняет все открытые скрипты.

UnregisterSyntaxHighlightervoid
# UnregisterSyntaxHighlighter
C#
public void UnregisterSyntaxHighlighter(EditorSyntaxHighlighter syntaxHighlighter);

Отменяет регистрацию EditorSyntaxHighlighter в редакторе. Примечание: EditorSyntaxHighlighter по-прежнему будет применяться к скриптам, которые уже открыты.

Параметры
ИмяТипПо умолчанию
syntaxHighlighterEditorSyntaxHighlighter—
UpdateDocsFromScriptvoid
# UpdateDocsFromScript
C#
public void UpdateDocsFromScript(Script script);

Обновляет документацию для указанного script. Примечание: Этот вызов следует выполнять при каждом изменении скрипта, чтобы поддерживать открытую документацию в актуальном состоянии.

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

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

EditorScriptChangedСобытие
# EditorScriptChanged
C#
public event ScriptEditor.EditorScriptChangedEventHandler EditorScriptChanged;

Выдается, когда пользователь изменил активный скрипт. Аргумент — недавно активированный Script.

Параметры обработчика
ИмяТипПо умолчанию
scriptScript—
ScriptCloseСобытие
# ScriptClose
C#
public event ScriptEditor.ScriptCloseEventHandler ScriptClose;

Выдается, когда редактор собирается закрыть активный скрипт. Аргумент — Script, который будет закрыт.

Параметры обработчика
ИмяТипПо умолчанию
scriptScript—
Документация Reckfell EngineНаверх ↑
БЫСТРЫЙ ПЕРЕХОДНачало работыEntity и иерархияC# & .NET 10Сцены и префабы
Руководства и полный API Reckfell K
reckfellENGINE
RECKFELL ACCOUNT

Вход в аккаунт

Войдите в аккаунт Reckfell.

Один аккаунт для всей платформы Reckfell.