reckfellENGINE

EditorSettings

Настройки среды редактора, отдельные от настроек проекта игры.

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

Получайте текущий объект через EditorInterface.Singleton.GetEditorSettings(). Читайте необязательные ключи через HasSetting() и GetSetting(), учитывая тип Variant. Не освобождайте заимствованный singleton.

Для C# выбор IDE находится в dotnet/editor/external_editor; общий обработчик Text Editor использует другую ветку настроек. Чтение значения не запускает IDE, не проверяет её установку и не компилирует проект.

Внешний редактор и диагностика.

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

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

EditorSettingsКонструктор
# EditorSettings
C#
public EditorSettings();

Методы24

AddPropertyInfovoid
# AddPropertyInfo
C#
public void AddPropertyInfo(Reckfell.Collections.Dictionary info);

Добавляет информацию о пользовательском свойстве к свойству. Словарь должен содержать:

  • name: string (имя свойства)
  • type: [int] (см. Variant.Type)
  • опционально hint: string
C#
var settings = GetEditorInterface().GetEditorSettings();
settings.Set("category/property_name", 0);

var propertyInfo = new Reckfell.Collections.Dictionary
{
    { "name", "category/propertyName" },
    { "type", Variant.Type.Int },
    { "hint", PropertyHint.Enum },
    { "hint_string", "one,two,three" },
};

settings.AddPropertyInfo(propertyInfo);
Параметры
ИмяТипПо умолчанию
infoReckfell.Collections.Dictionary—
AddShortcutvoid
# AddShortcut
C#
public void AddShortcut(string path, Shortcut shortcut);

Добавляет shortcut, путь к которому задается параметром path. Параметр path определяет, как ярлык будет организован и отображаться в настройках ярлыков редактора. Формат пути влияет на отображение следующим образом:

  • "name" (без косой черты): Создает категорию с именем name, ярлык которой отображается как name.
  • "category/name" (с одной косой чертой): Отображается как name в разделе category.
  • "category/name/extra" (с несколькими косыми чертами): Дополнительные компоненты пути игнорируются, поэтому это работает так же, как "category/name". Примечание: Ярлыки сохраняются в настройках редактора только в том случае, если они отличаются от своего исходного/стандартного состояния. Это означает, что пустые сочетания клавиш, которые изначально были пустыми, не будут сохраняться между сеансами редактора и должны быть добавлены заново. Если сочетание клавиш с тем же path уже существует, этот метод обновит его новым shortcut вместо создания дубликата.
Параметры
ИмяТипПо умолчанию
pathstring—
shortcutShortcut—
CheckChangedSettingsInGroupbool
# CheckChangedSettingsInGroup
C#
public bool CheckChangedSettingsInGroup(string settingPrefix);

Проверяет, существуют ли какие-либо настройки с префиксом setting_prefix в наборе измененных настроек. См. также EditorSettings.GetChangedSettings.

Стереть

Параметры
ИмяТипПо умолчанию
settingPrefixstring—
Возвращает bool
Erasevoid
# Erase
C#
public void Erase(string property);

Удаляет настройку, имя которой указано в property.

Параметры
ИмяТипПо умолчанию
propertystring—
GetChangedSettingsstring[]
# GetChangedSettings
C#
public string[] GetChangedSettings();

Получает массив настроек, которые были изменены с момента последнего сохранения. Обратите внимание, что внутренне changed_settings очищается после успешного сохранения, поэтому обычно наиболее подходящим местом для использования этого метода является обработка EditorSettings.NotificationEditorSettingsChanged.

Возвращает string[]
GetFavoritesstring[]
# GetFavorites
C#
public string[] GetFavorites();

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

Возвращает string[]
GetProjectMetadataVariant
# GetProjectMetadata
C#
public Variant GetProjectMetadata(string section, string key, Variant @default = default);

Возвращает метаданные, специфичные для проекта, для указанных section и key. Если метаданные не существуют, вместо них будет возвращен default. См. также EditorSettings.SetProjectMetadata.

Параметры
ИмяТипПо умолчанию
sectionstring—
keystring—
defaultVariantdefault
Возвращает Variant
GetRecentDirsstring[]
# GetRecentDirs
C#
public string[] GetRecentDirs();

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

Возвращает string[]
GetSettingVariant
# GetSetting
C#
public Variant GetSetting(string name);

Читает значение настройки редактора по точному пути. Для необязательного ключа сначала вызовите HasSetting(); проверьте тип Variant до преобразования. Настройки dotnet/editor/ и text_editor/external/ относятся к разным обработчикам.

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

Точный ключ настройки редактора, не локализованная подпись UI.

Возвращает Variant

Текущее значение настройки как Variant.

GetShortcutShortcut
# GetShortcut
C#
public Shortcut GetShortcut(string path);

Возвращает сочетание клавиш, указанное в path. Пытается найти встроенное действие, если в списке сочетаний клавиш не найдено ни одного сочетания клавиш с указанным путем. Если найдено, добавляет его в список и возвращает, в противном случае возвращает null.

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

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

Возвращает string[]
HasSettingbool
# HasSetting
C#
public bool HasSetting(string name);

Проверяет наличие настройки в текущем объекте редактора. Используйте перед GetSetting() для необязательных настроек интеграций. Наличие ключа не доказывает установку программы или успешный запуск IDE.

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

Точный путь настройки, например dotnet/editor/external_editor.

Возвращает bool

true при наличии ключа настройки.

HasShortcutbool
# HasShortcut
C#
public bool HasShortcut(string path);

Возвращает true, если указанные в path клавиши сочетания существует, false в противном случае.

Параметры
ИмяТипПо умолчанию
pathstring—
Возвращает bool
IsShortcutbool
# IsShortcut
C#
public bool IsShortcut(string path, InputEvent @event);

Возвращает true, если указанные в path клавиши сочетания совпадают с событием, указанным в event, и false в противном случае.

Параметры
ИмяТипПо умолчанию
pathstring—
eventInputEvent—
Возвращает bool
MarkSettingChangedvoid
# MarkSettingChanged
C#
public void MarkSettingChanged(string setting);

Отмечает переданную настройку редактора как измененную, см. EditorSettings.GetChangedSettings. Будут приняты только существующие настройки (см. EditorSettings.HasSetting).

Параметры
ИмяТипПо умолчанию
settingstring—
RemoveShortcutvoid
# RemoveShortcut
C#
public void RemoveShortcut(string path);

Удаляет клавиши сочетания, указанные в path.

Параметры
ИмяТипПо умолчанию
pathstring—
SetBuiltinActionOverridevoid
# SetBuiltinActionOverride
C#
public void SetBuiltinActionOverride(string name, Reckfell.Collections.Array<InputEvent> actionsList);

Переопределяет встроенное действие редактора name действиями ввода, определенными в actions_list.

Параметры
ИмяТипПо умолчанию
namestring—
actionsListReckfell.Collections.Array<InputEvent>—
SetFavorites2 перегрузки
# SetFavorites · 1/2
C#
public void SetFavorites(ReadOnlySpan<string> dirs);

Устанавливает список избранных файлов и каталогов для этого проекта.

Параметры
ИмяТипПо умолчанию
dirsReadOnlySpan<string>—
# SetFavorites · 2/2
C#
public void SetFavorites(string[] dirs);

Устанавливает список избранных файлов и каталогов для этого проекта.

Параметры
ИмяТипПо умолчанию
dirsstring[]—
SetInitialValuevoid
# SetInitialValue
C#
public void SetInitialValue(StringName name, Variant value, bool updateCurrent);

Устанавливает начальное значение параметра, указанного name, на value. Это используется для предоставления значения для кнопки Revert в настройках редактора. Если update_current равно true, параметр также сбрасывается на value.

Параметры
ИмяТипПо умолчанию
nameStringName—
valueVariant—
updateCurrentbool—
SetProjectMetadatavoid
# SetProjectMetadata
C#
public void SetProjectMetadata(string section, string key, Variant data);

Устанавливает метаданные, специфичные для проекта, с указанием section, key и data. Эти метаданные хранятся вне папки проекта и, следовательно, не будут проверены в системе контроля версий. См. также EditorSettings.GetProjectMetadata.

Параметры
ИмяТипПо умолчанию
sectionstring—
keystring—
dataVariant—
SetRecentDirs2 перегрузки
# SetRecentDirs · 1/2
C#
public void SetRecentDirs(ReadOnlySpan<string> dirs);

Устанавливает список недавно посещенных папок в диалоговом окне файлов для этого проекта.

Параметры
ИмяТипПо умолчанию
dirsReadOnlySpan<string>—
# SetRecentDirs · 2/2
C#
public void SetRecentDirs(string[] dirs);

Устанавливает список недавно посещенных папок в диалоговом окне файлов для этого проекта.

Параметры
ИмяТипПо умолчанию
dirsstring[]—
SetSettingvoid
# SetSetting
C#
public void SetSetting(string name, Variant value);

Устанавливает value настройки, указанной name. Это эквивалентно использованию ReckfellObject.Set в экземпляре EditorSettings.

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

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

SettingsChangedСобытие
# SettingsChanged
C#
public event Action SettingsChanged;

Выдается после изменения каких-либо настроек редактора.

Поля и константы1

NotificationEditorSettingsChangedПоле
# NotificationEditorSettingsChanged
C#
public const long NotificationEditorSettingsChanged = 10000;

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

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

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

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

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