EditorInterface

public bool DistractionFreeMode { get; set; }

Читает или переключает режим редактора с уменьшенным количеством отвлекающих панелей. Не переводит игру в полноэкранный режим и не меняет состояние проекта на диске.

public bool MovieMakerEnabled { get; set; }

Если true, режим Создатель кино включен в редакторе. См. MovieWriter для получения дополнительной информации.

public static EditorInterface Singleton { get; }

Единственный интерфейс работающего редактора. Используйте из кода расширения редактора; это не сервис экспортированной игры. Не освобождайте экземпляр.

public void AddRootEntity(Entity node);

Делает node корнем текущей открытой сцены. Работает только если сцена пуста. Если node является экземпляром сцены, будет создана наследующая сцена.

public Error CloseScene();

Закрывает текущий уровень напрямую, отбрасывая несохранённые изменения без диалога подтверждения в текущей реализации. Сначала сохраните нужные данные. Возвращает Error.Ok при выполнении закрытия либо Error.DoesNotExist для начальной пустой вкладки без уровня.

public void EditEntity(Entity node);

Передаёт Entity редактору для редактирования через инспектор. Не создаёт Entity и не добавляет её в уровень. Переданный объект сохраняет своего владельца.

public void EditResource(Resource resource);

Открывает переданный ресурс для редактирования. Не сохраняет его на диск. Для Script с переходом к строке и столбцу используйте EditScript.

public void EditScript(Script script, int line = -1, int column = 0, bool grabFocus = true);

Открывает Script в настроенном редакторе соответствующего языка, в том числе внешнем. Положительные line и column задаются от 1: обёртка вычитает 1 из обоих значений. Значения по умолчанию -1 и 0 не означают строку и столбец 0. grabFocus запрашивает фокус.

public Control GetBaseControl();

Возвращает базовый Control интерфейса редактора, например для размещения собственного диалога. Это объект редактора: не удаляйте, не освобождайте и не меняйте ему родителя. Собственные элементы удаляйте при отключении расширения.

public EditorCommandPalette GetCommandPalette();

Возвращает общую палитру команд редактора. Это не команда открыть палитру. Собственные команды снимайте при отключении расширения; сервис не освобождайте.

public ContentBrowser GetContentBrowser();

Возвращает общий ContentBrowser редактора. Пути и выделение файлов относятся к этому браузеру, а не к выделению Entity. Не освобождайте панель.

public string GetCurrentDirectory();

Возвращает текущую директорию ContentBrowser. Не рабочую директорию процесса и не обязательно корень проекта.

public string GetCurrentFeatureProfile();

Возвращает имя текущего активированного профиля функций. Если в данный момент активен профиль по умолчанию, вместо него возвращается пустая строка. Чтобы получить ссылку на EditorFeatureProfile, необходимо загрузить профиль функций с помощью EditorFeatureProfile.LoadFromFile. Примечание: Профили функций, созданные через пользовательский интерфейс, загружаются из каталога feature_profiles в виде файла с расширением .profile. Папку конфигурации редактора можно найти с помощью EditorPaths.GetConfigDir.

public string GetCurrentPath();

Возвращает текущий путь ContentBrowser. Не считайте его всегда директорией: для каталога используйте GetCurrentDirectory.

public EditorDock GetDockByName(string name);

Ищет зарегистрированную панель по отображаемому заголовку. Это не поиск Entity по Name и не поиск плагина по каталогу.

public Entity GetEditedSceneRoot();

Читает корень текущей редактируемой иерархии. Не равно CurrentScene запущенной игры. В проверке вернул корень открытого Fixture.rscene; не изменяет иерархию.

public string GetEditorLanguage();

Возвращает выбранный в настройках язык интерфейса редактора. Это не локаль экспортируемой игры.

public VBoxContainer GetEditorMainScreen();

Устаревший доступ к VBoxContainer для прежних расширений главного экрана. Он больше не представляет весь главный экран редактора. Для панели используйте GetDockByName; для общего родителя собственного UI — GetBaseControl. Возвращённый контейнер принадлежит редактору.

public EditorPaths GetEditorPaths();

Возвращает общий EditorPaths с путями данных и настроек редактора. Не подменяйте этими путями пути ресурсов проекта и не освобождайте сервис.

public float GetEditorScale();

Возвращает текущий множитель масштаба интерфейса редактора EDSCALE. Для собственных фиксированных размеров умножайте базовое значение на этот коэффициент; это не разрешение экрана и не масштаб камеры.

public EditorSettings GetEditorSettings();

Возвращает текущий объект настроек редактора. Это настройки среды редактора, не ProjectSettings игры. Ссылка заимствована: не освобождайте singleton и не создавайте новый экземпляр для обычного чтения.

public Theme GetEditorTheme();

Возвращает общий ресурс темы редактора. Читайте из него стили, цвета и значки для своего UI. Изменение ресурса затрагивает его пользователей; не используйте общую тему как личную копию.

public EditorToaster GetEditorToaster();

Возвращает общий сервис уведомлений редактора. Получение ссылки ещё не показывает сообщение. Не освобождайте сервис.

public EditorUndoRedoManager GetEditorUndoRedo();

Возвращает общий EditorUndoRedoManager. Изменения расширения оформляйте действиями подходящей истории; получение менеджера само по себе не записывает Undo. Не освобождайте сервис.

public SubViewport GetEditorViewport2D();

Возвращает SubViewport редактирования 2D. Он принадлежит редактору, не запущенной игре. Не освобождайте и не перенастраивайте его как собственный viewport.

public SubViewport GetEditorViewport3D(int idx = 0);

Возвращает один из четырёх SubViewport редактора 3D по idx от 0 до 3. Неверный индекс приводит к ошибке и null. Это не камера и не viewport запущенной игры; объект принадлежит редактору.

public float GetEntity3DRotateSnap();

Возвращает значение, на которое установлена привязка к вращательному полю в 3D-редакторе.

public float GetEntity3DScaleSnap();

Возвращает количество единиц, на которое установлена привязка масштаба в 3D-редакторе.

public float GetEntity3DTranslateSnap();

Возвращает значение, на которое установлена привязка к перемещению в 3D-редакторе.

public EditorInspector GetInspector();

Возвращает инспектор редактора. Для показа объекта используйте InspectObject или EditResource/EditEntity. Не освобождайте и не перемещайте сам инспектор.

public EditorMcpService GetMcpService();

Возвращает встроенный диспетчер команд MCP, совместно используемый внешними клиентами и доком AI. Доступно в редакторе построено с помощью модуля MCP. Команды работают на главной нитью; асинхронные операции возвращают идентификатор работы. Эта услуга, принадлежащая редактору, не должна быть освобождена.

public Reckfell.Collections.Array<Entity> GetOpenSceneRoots();

Возвращает новый массив корневых Entity открытых уровней, пропуская отсутствующие корни. Ссылки ведут на реальные объекты редактора, не копии; не освобождайте их. Из-за пропусков не сопоставляйте индексы вслепую с GetOpenScenes.

public string[] GetOpenScenes();

Возвращает новый string[] путей открытых уровней в порядке вкладок. Несохранённый новый уровень может иметь пустой путь. Массив не является списком экземпляров Entity.

public string GetPlayingScene();

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

public EditorFileSystem GetResourceFilesystem();

Возвращает общий EditorFileSystem, индексирующий ресурсы проекта. Это не универсальный файловый API и не копия каталога. Не освобождайте сервис.

public EditorResourcePreview GetResourcePreviewer();

Возвращает общий EditorResourcePreview для запросов превью ресурсов. Сам вызов не создаёт готовую текстуру и не ожидает завершения генерации. Не освобождайте сервис.

public ScenePaint2DEditor GetScenePaint2D();

Возвращает общий инструмент ScenePaint2DEditor редактора. Это не новый экземпляр инструмента и не Entity игры; не освобождайте его.

public ScriptEditor GetScriptEditor();

Возвращает установленный экземпляр панели Script. Его текущий документ может быть справкой, поэтому GetCurrentScript()/GetCurrentEditor() не обязаны возвращать скрипт. Это не объект внешней C#-IDE.

public string[] GetSelectedPaths();

Возвращает новый string[] путей, выбранных в ContentBrowser. Изменение массива не меняет выделение браузера. Это не пути выбранных Entity.

public EditorSelection GetSelection();

Возвращает общий EditorSelection редактора. Используйте его для чтения и изменения выделенных Entity; это не список выбранных файлов ContentBrowser. Не освобождайте сервис.

public string[] GetUnsavedScenes();

Возвращает пути открытых уровней с несохранёнными изменениями. У нового уровня путь может быть пустым. Это снимок состояния, не операция сохранения.

public void InspectObject(ReckfellObject @object, string forProperty = "", bool inspectorOnly = false);

Показывает заданное свойство для заданного object в доке Inspector редактора. Если inspector_only равно true, плагины не будут пытаться редактировать object.

public bool IsDistractionFreeModeEnabled();

Читает или переключает режим редактора с уменьшенным количеством отвлекающих панелей. Не переводит игру в полноэкранный режим и не меняет состояние проекта на диске.

public bool IsEntity3DSnapEnabled();

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

public bool IsExiting();

Возвращает текущее состояние выхода из редактора. Не завершает редактор.

public bool IsMultiWindowEnabled();

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

public bool IsObjectEdited(ReckfellObject @object);

Читает флаг edited переданного объекта. Нужен ненулевой объект. Это не проверка того, отображается ли объект в инспекторе, и не полный список несохранённых уровней.

public bool IsPlayingScene();

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

public bool IsPluginEnabled(string plugin);

Читает регистрацию включённого плагина редактора. Не проверяет существование каталога на диске и не доказывает правильность всех его операций.

public Reckfell.Collections.Array<Texture2D> MakeMeshPreviews(Reckfell.Collections.Array<Mesh> meshes, int previewSize);

Возвращает предварительные просмотры сетки, отрисованные в заданном размере, как Reckfell.Collections.Array из Texture2D-ов.

public void MarkSceneAsUnsaved();

Помечает историю текущего уровня несохранённой и обновляет вкладки. Не записывает файл и не создаёт действие Undo за изменения расширения.

public void OpenSceneFromPath(string scenePath);

Запрашивает открытие уровня по пути. Вызов ничего не делает, пока редактор уже переключает уровень. setInherited=true открывает наследуемый вариант. Метод void не подтверждает успешное завершение загрузки.

public void OpenSceneFromPath(string sceneFilepath, bool setInherited = false);

Запрашивает открытие уровня по пути. Вызов ничего не делает, пока редактор уже переключает уровень. setInherited=true открывает наследуемый вариант. Метод void не подтверждает успешное завершение загрузки.

public void PlayCurrentScene();

Воспроизводит текущую активную сцену.

public void PlayCustomScene(string sceneFilepath);

Воспроизводит сцену, указанную в пути к файлу.

public void PlayMainScene();

Играет главную сцену.

public void PopupCreateDialog(Callable callback, StringName baseType = null, string currentType = "", string dialogTitle = "", Reckfell.Collections.Array<StringName> typeBlocklist = null);

Открывает диалоговое окно редактора для создания объекта. Параметр callback должен принимать один аргумент типа string, который будет содержать имя типа выбранного объекта (или путь к скрипту типа, если тип создан из скрипта), или пустую строку, если ни один элемент не выбран. Параметр base_type указывает базовый тип отображаемых объектов. Например, если вы установите его значение на "Resource", в диалоговом окне создания будут отображаться все типы, производные от Resource. Параметр current_type будет передан в поле поиска диалогового окна создания, и указанный тип можно будет сразу выбрать при появлении диалогового окна. Если current_type не является производным от base_type, в диалоговом окне не будет результатов этого типа. Параметр dialog_title позволяет определить пользовательский заголовок для диалогового окна. Это полезно, если вы хотите точно указать на назначение диалогового окна. Если параметр dialog_title является пустой строкой, в качестве заголовка по умолчанию будет использоваться «Создать новый базовый тип». Параметр type_blocklist содержит список имен типов, и типы из этого списка будут скрыты из диалога создания. Примечание: Попытка указать базовый тип в параметре type_blocklist скроет из диалога создания все типы, производные от базового типа.

public void PopupDialog(Window dialog, Rect2I? rect = default);

Выводит dialog в пользовательском интерфейсе редактора с помощью Window.PopupExclusive. Диалог не должен иметь текущего родителя, в противном случае метод не сработает. См. также Window.SetUnparentWhenInvisible.

public void PopupDialogCentered(Window dialog, Vector2I? minsize = default);

Выводит dialog в пользовательском интерфейсе редактора с помощью Window.PopupExclusiveCentered. Диалог не должен иметь текущего родителя, в противном случае метод не сработает. См. также Window.SetUnparentWhenInvisible.

public void PopupDialogCenteredClamped(Window dialog, Vector2I? minsize = default, float fallbackRatio = 0.75f);

Выводит dialog в пользовательском интерфейсе редактора с помощью Window.PopupExclusiveCenteredClamped. Диалог не должен иметь текущего родителя, в противном случае метод не сработает. См. также Window.SetUnparentWhenInvisible.

public void PopupDialogCenteredRatio(Window dialog, float ratio = 0.8f);

Выводит dialog в пользовательском интерфейсе редактора с помощью Window.PopupExclusiveCenteredRatio. Диалог не должен иметь текущего родителя, в противном случае метод не сработает. См. также Window.SetUnparentWhenInvisible.

public void PopupEntitySelector(Callable callback, Reckfell.Collections.Array<StringName> validTypes);

Введите диалог редактора для выбора Entity из отредактированной сцены. callback должен взять один аргумент типа EntityPath. Он предлагается выбранному лицу EntityPath или пустой путь ^"" если диалог отменен. Если valid_types В диалоге будут показаны только узлы, которые соответствуют одному из перечисленных Entity типа: если current_value Предусмотрено, а именно: Entity будет автоматически выбираться на дереве, если оно существует. Пример: Показать диалог выбора узла, как только этот узел будет добавлен к дереву впервые:

public void PopupEntitySelector(Callable callback, Reckfell.Collections.Array<StringName> validTypes = null, Entity currentValue = null);

Введите диалог редактора для выбора Entity из отредактированной сцены. callback должен взять один аргумент типа EntityPath. Он предлагается выбранному лицу EntityPath или пустой путь ^"" если диалог отменен. Если valid_types В диалоге будут показаны только узлы, которые соответствуют одному из перечисленных Entity типа: если current_value Предусмотрено, а именно: Entity будет автоматически выбираться на дереве, если оно существует. Пример: Показать диалог выбора узла, как только этот узел будет добавлен к дереву впервые:

public void PopupMethodSelector(ReckfellObject @object, Callable callback, string currentValue = "");

Открывает диалог редактора для выбора метода из object. callback должен принимать один аргумент типа string, который будет содержать имя выбранного метода или будет пустым, если диалог будет отменен. Если указано current_value, метод будет автоматически выбран в списке методов, если он существует.

public void PopupPropertySelector(ReckfellObject @object, Callable callback, int[] typeFilter);

Открывает диалог редактора для выбора свойств из object. callback должен принимать один аргумент типа EntityPath. Он вызывается для выбранного пути свойства (см. EntityPath.GetAsPropertyPath) или пустого пути ^"", если диалог отменен. Если указан type_filter, диалог покажет только свойства, которые соответствуют одному из перечисленных значений Variant.Type. Если указан current_value, свойство будет автоматически выбрано в списке свойств, если оно существует.

public void PopupPropertySelector(ReckfellObject @object, Callable callback, int[] typeFilter = null, string currentValue = "");

Открывает диалог редактора для выбора свойств из object. callback должен принимать один аргумент типа EntityPath. Он вызывается для выбранного пути свойства (см. EntityPath.GetAsPropertyPath) или пустого пути ^"", если диалог отменен. Если указан type_filter, диалог покажет только свойства, которые соответствуют одному из перечисленных значений Variant.Type. Если указан current_value, свойство будет автоматически выбрано в списке свойств, если оно существует.

public void PopupPropertySelector(ReckfellObject @object, Callable callback, ReadOnlySpan<int> typeFilter);

Открывает диалог редактора для выбора свойств из object. callback должен принимать один аргумент типа EntityPath. Он вызывается для выбранного пути свойства (см. EntityPath.GetAsPropertyPath) или пустого пути ^"", если диалог отменен. Если указан type_filter, диалог покажет только свойства, которые соответствуют одному из перечисленных значений Variant.Type. Если указан current_value, свойство будет автоматически выбрано в списке свойств, если оно существует.

public void PopupPropertySelector(ReckfellObject @object, Callable callback, ReadOnlySpan<int> typeFilter, string currentValue);

Открывает диалог редактора для выбора свойств из object. callback должен принимать один аргумент типа EntityPath. Он вызывается для выбранного пути свойства (см. EntityPath.GetAsPropertyPath) или пустого пути ^"", если диалог отменен. Если указан type_filter, диалог покажет только свойства, которые соответствуют одному из перечисленных значений Variant.Type. Если указан current_value, свойство будет автоматически выбрано в списке свойств, если оно существует.

public void PopupQuickOpen(Callable callback, Reckfell.Collections.Array<StringName> baseTypes = null);

Открывает диалог редактора для быстрого выбора файла ресурсов. callback должен принимать один аргумент типа string, который будет содержать путь к выбранному ресурсу или будет пустым, если диалог будет отменен. Если указан base_types, диалог покажет только ресурсы, соответствующие этим типам. Поддерживаются только типы, производные от Resource.

public void ReloadSceneFromPath(string sceneFilepath);

Запрашивает повторную загрузку открытого уровня с диска. Может заменить несохранённые изменения; сначала решите, нужно ли их сохранить. Во время переключения уровня запрос игнорируется. Метод не возвращает результат загрузки.

public void RestartEditor(bool save = true);

Запрашивает перезапуск редактора. При save=true сначала вызывает сохранение всех уровней; false пропускает этот шаг. Вызов не возвращает подтверждение успешной записи.

public void SaveAllScenes();

Вызывает сохранение всех открытых уровней через редактор. Не возвращает сводного результата записи и не означает сохранение всех произвольных ресурсов проекта.

public Error SaveScene();

Для текущего уровня с корнем и уже заданным путём вызывает SaveSceneAs и возвращает Error.Ok. Без корня или пути возвращает Error.CantCreate. Ok здесь не является переданным результатом записи файла: нижележащий вызов void. Для нового уровня сначала нужен SaveSceneAs.

public void SaveSceneAs(string path, bool withPreview = true);

Запрашивает сохранение текущего уровня по path; withPreview управляет созданием превью. Метод void не возвращает код ошибки записи. Сохраняйте уровень в .rscene; этот вызов не заменяет отдельный процесс создания .rprefab.

public void SelectFile(string file);

Передаёт ContentBrowser запрос выбрать файл. Это навигация по ресурсам редактора, а не загрузка файла в игру и не изменение выделения Entity.

public void SetCurrentFeatureProfile(string profileName);

Выбирает и активирует указанный профиль функций с заданным profile_name. Установите profile_name на пустую строку, чтобы сбросить до профиля функций по умолчанию. Профиль функций можно создать программно с помощью класса EditorFeatureProfile. Примечание: Активируемый профиль функций должен находиться в каталоге feature_profiles в виде файла с расширением .profile. Если профиль не найден, возникает ошибка. Папку конфигурации редактора можно найти с помощью EditorPaths.GetConfigDir.

public void SetDistractionFreeMode(bool enter);

Читает или переключает режим редактора с уменьшенным количеством отвлекающих панелей. Не переводит игру в полноэкранный режим и не меняет состояние проекта на диске.

public void SetMainScreenEditor(string name);

Устаревший способ сфокусировать панель главного экрана по имени. При неизвестном имени сообщает об ошибке. Для нового кода получите панель через GetDockByName, проверьте null и вызовите MakeVisible.

public void SetObjectEdited(ReckfellObject @object, bool edited);

Устанавливает флаг edited ненулевого объекта. Не меняет его свойства, не сохраняет файл и не создаёт Undo. Для несохранённого состояния текущего уровня используйте подходящую историю или MarkSceneAsUnsaved.

public void SetPluginEnabled(string plugin, bool enabled);

Включает или отключает редакторский плагин. Требует работающего редактора и корректного plugin.cfg/tool-скрипта. Метод не возвращает подтверждение: проверяйте IsPluginEnabled и сообщения загрузки.

public void StopPlayingScene();

Останавливает текущую воспроизводимую сцену.