reckfellENGINE

EditorProperty

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

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

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

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

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

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

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

Свойства12

CheckableСвойство
# Checkable
C#
public bool Checkable { get; set; }

Используется инспектором, устанавливается в true, когда свойство можно проверить.

CheckedСвойство
# Checked
C#
public bool Checked { get; set; }

Используется инспектором, устанавливается в true при проверке свойства.

DeletableСвойство
# Deletable
C#
public bool Deletable { get; set; }

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

DrawBackgroundСвойство
# DrawBackground
C#
public bool DrawBackground { get; set; }

Используется инспектором, устанавливается в true при прорисовке фона свойства.

DrawLabelСвойство
# DrawLabel
C#
public bool DrawLabel { get; set; }

Используется инспектором, устанавливается в true при рисовании метки свойства.

DrawWarningСвойство
# DrawWarning
C#
public bool DrawWarning { get; set; }

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

KeyingСвойство
# Keying
C#
public bool Keying { get; set; }

Используется инспектором, устанавливается в true, когда свойство может добавлять ключи для анимации.

LabelСвойство
# Label
C#
public string Label { get; set; }

Установите это свойство, чтобы изменить метку (если вы хотите ее отобразить).

NameSplitRatioСвойство
# NameSplitRatio
C#
public float NameSplitRatio { get; set; }

Соотношение распределения пространства между меткой и полем редактирования.

ReadOnlyСвойство
# ReadOnly
C#
public bool ReadOnly { get; set; }

Используется инспектором, устанавливается в true, когда свойство доступно только для чтения.

SelectableСвойство
# Selectable
C#
public bool Selectable { get; set; }

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

UseFoldingСвойство
# UseFolding
C#
public bool UseFolding { get; set; }

Используется инспектором, устанавливается в true, когда свойство использует свертывание.

Методы37

AddFocusablevoid
# AddFocusable
C#
public void AddFocusable(Control control);

Если какой-либо из добавленных элементов управления может получить фокус клавиатуры, добавьте его здесь. Это гарантирует, что фокус будет восстановлен при обновлении инспектора.

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

Рисовать свойство как не выбранное. Используется инспектором.

EmitChangedvoid
# EmitChanged
C#
public void EmitChanged(StringName property, Variant value, StringName field = null, bool changing = false);

Сообщает Inspector о пользовательском изменении. Не заменяйте прямым присваиванием, если нужен редакторский путь изменения и Undo/Redo. Не вызывайте из обычного обновления виджета по модели.

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

Имя изменяемого свойства, обычно GetEditedProperty().

value

Новое Variant-совместимое значение, а не сам виджет.

field

Необязательное имя подкомпонента; для изменения свойства целиком пример оставляет пустым.

changing

Флаг непрерывного изменения, например во время набора текста. Пример завершённого числового шага использует false; жесты перетаскивания не проверялись.

GetEditedObjectReckfellObject
# GetEditedObject
C#
public ReckfellObject GetEditedObject();

Читает объект, назначенный этому EditorProperty Inspector. Для начального обновления и смены выбора проверяйте наличие объекта перед Get.

Возвращает ReckfellObject

Текущий ReckfellObject либо null. В проверке это тот же DocsInspectorSettings, который открыт в главном Inspector.

GetEditedPropertyStringName
# GetEditedProperty
C#
public StringName GetEditedProperty();

Читает имя свойства, привязанного Inspector к этому виджету. Используйте для Get и EmitChanged вместо жёстко заданного имени другого поля.

Возвращает StringName

StringName привязанного свойства; проверено Amount. Это не отображаемая подпись Label.

GetLabelstring
# GetLabel
C#
public string GetLabel();
Возвращает string
GetNameSplitRatiofloat
# GetNameSplitRatio
C#
public float GetNameSplitRatio();
Возвращает float
IsCheckablebool
# IsCheckable
C#
public bool IsCheckable();
Возвращает bool
IsCheckedbool
# IsChecked
C#
public bool IsChecked();
Возвращает bool
IsDeletablebool
# IsDeletable
C#
public bool IsDeletable();
Возвращает bool
IsDrawBackgroundbool
# IsDrawBackground
C#
public bool IsDrawBackground();
Возвращает bool
IsDrawLabelbool
# IsDrawLabel
C#
public bool IsDrawLabel();
Возвращает bool
IsDrawWarningbool
# IsDrawWarning
C#
public bool IsDrawWarning();
Возвращает bool
IsKeyingbool
# IsKeying
C#
public bool IsKeying();
Возвращает bool
IsReadOnlybool
# IsReadOnly
C#
public bool IsReadOnly();
Возвращает bool
IsSelectablebool
# IsSelectable
C#
public bool IsSelectable();
Возвращает bool
IsSelectedbool
# IsSelected
C#
public bool IsSelected();

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

Возвращает bool
IsUsingFoldingbool
# IsUsingFolding
C#
public bool IsUsingFolding();
Возвращает bool
Selectvoid
# Select
C#
public void Select(int focusable = -1);

Свойство рисования выбрано. Используется инспектором.

Параметры
ИмяТипПо умолчанию
focusableint-1
SetBottomEditorvoid
# SetBottomEditor
C#
public void SetBottomEditor(Control editor);

Размещает элемент управления editor под меткой свойства. Элемент управления должен быть предварительно добавлен с помощью Entity.AddChild.

Параметры
ИмяТипПо умолчанию
editorControl—
SetCheckablevoid
# SetCheckable
C#
public void SetCheckable(bool checkable);
Параметры
ИмяТипПо умолчанию
checkablebool—
SetCheckedvoid
# SetChecked
C#
public void SetChecked(bool @checked);
Параметры
ИмяТипПо умолчанию
checkedbool—
SetDeletablevoid
# SetDeletable
C#
public void SetDeletable(bool deletable);
Параметры
ИмяТипПо умолчанию
deletablebool—
SetDrawBackgroundvoid
# SetDrawBackground
C#
public void SetDrawBackground(bool drawBackground);
Параметры
ИмяТипПо умолчанию
drawBackgroundbool—
SetDrawLabelvoid
# SetDrawLabel
C#
public void SetDrawLabel(bool drawLabel);
Параметры
ИмяТипПо умолчанию
drawLabelbool—
SetDrawWarningvoid
# SetDrawWarning
C#
public void SetDrawWarning(bool drawWarning);
Параметры
ИмяТипПо умолчанию
drawWarningbool—
SetKeyingvoid
# SetKeying
C#
public void SetKeying(bool keying);
Параметры
ИмяТипПо умолчанию
keyingbool—
SetLabelvoid
# SetLabel
C#
public void SetLabel(string text);
Параметры
ИмяТипПо умолчанию
textstring—
SetLabelReferencevoid
# SetLabelReference
C#
public void SetLabelReference(Control control);

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

Параметры
ИмяТипПо умолчанию
controlControl—
SetNameSplitRatiovoid
# SetNameSplitRatio
C#
public void SetNameSplitRatio(float ratio);
Параметры
ИмяТипПо умолчанию
ratiofloat—
SetObjectAndPropertyvoid
# SetObjectAndProperty
C#
public void SetObjectAndProperty(ReckfellObject @object, StringName property);

Назначает объект и свойство для редактирования.

Параметры
ИмяТипПо умолчанию
objectReckfellObject—
propertyStringName—
SetReadOnlyvoid
# SetReadOnly
C#
public void SetReadOnly(bool readOnly);

Вызывается при изменении статуса свойства «только для чтения». Может использоваться для изменения пользовательских элементов управления в состояние «только для чтения» или «изменяемое».

###обновленное

Параметры
ИмяТипПо умолчанию
readOnlybool—
SetSelectablevoid
# SetSelectable
C#
public void SetSelectable(bool selectable);
Параметры
ИмяТипПо умолчанию
selectablebool—
SetUseFoldingvoid
# SetUseFolding
C#
public void SetUseFolding(bool useFolding);
Параметры
ИмяТипПо умолчанию
useFoldingbool—
UpdatePropertyvoid
# UpdateProperty
C#
public void UpdateProperty();

При вызове этой виртуальной функции вам необходимо обновить свой редактор.

_SetReadOnlyvoid
# _SetReadOnly
C#
public virtual void _SetReadOnly(bool readOnly);

Callback для синхронизации собственных элементов с режимом только чтения. Недостаточно изменить внешний вид: блокируйте и обработчик, посылающий EmitChanged.

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

true запрещает изменение через ваш интерфейс; false возвращает обычное редактирование.

_UpdatePropertyvoid
# _UpdateProperty
C#
public virtual void _UpdateProperty();

Обновляет интерфейс из текущего состояния модели. В переопределении читайте GetEditedObject/GetEditedProperty и задавайте виджет без сигнала изменения; пример использует SetValueNoSignal.

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

MultiplePropertiesChangedСобытие
# MultiplePropertiesChanged
C#
public event EditorProperty.MultiplePropertiesChangedEventHandler MultiplePropertiesChanged;

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

Параметры обработчика
ИмяТипПо умолчанию
propertiesstring[]—
valueReckfell.Collections.Array—
ObjectIdSelectedСобытие
# ObjectIdSelected
C#
public event EditorProperty.ObjectIdSelectedEventHandler ObjectIdSelected;

Используется подинспекторами. Object ID.

Параметры обработчика
ИмяТипПо умолчанию
propertyStringName—
idlong—
PropertyCanRevertChangedСобытие
# PropertyCanRevertChanged
C#
public event EditorProperty.PropertyCanRevertChangedEventHandler PropertyCanRevertChanged;

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

Параметры обработчика
ИмяТипПо умолчанию
propertyStringName—
canRevertbool—
PropertyChangedСобытие
# PropertyChanged
C#
public event EditorProperty.PropertyChangedEventHandler PropertyChanged;

Не вызывайте его вручную, вместо этого используйте метод EditorProperty.EmitChanged.

Параметры обработчика
ИмяТипПо умолчанию
propertyStringName—
valueVariant—
fieldStringName—
changingbool—
PropertyCheckedСобытие
# PropertyChecked
C#
public event EditorProperty.PropertyCheckedEventHandler PropertyChecked;

Выдается при проверке свойства. Используется внутри.

Параметры обработчика
ИмяТипПо умолчанию
propertyStringName—
checkedbool—
PropertyDeletedСобытие
# PropertyDeleted
C#
public event EditorProperty.PropertyDeletedEventHandler PropertyDeleted;

Выдается при удалении свойства. Используется внутри.

Параметры обработчика
ИмяТипПо умолчанию
propertyStringName—
PropertyFavoritedСобытие
# PropertyFavorited
C#
public event EditorProperty.PropertyFavoritedEventHandler PropertyFavorited;

Используйте его, если вы хотите отметить свойство как избранное и отобразить его в верхней части инспектора.

Параметры обработчика
ИмяТипПо умолчанию
propertyStringName—
favoritedbool—
PropertyKeyedСобытие
# PropertyKeyed
C#
public event EditorProperty.PropertyKeyedEventHandler PropertyKeyed;

Выдайте его, если вы хотите добавить это значение в качестве ключа анимации (сначала проверьте, включено ли ключевое воздействие).

Параметры обработчика
ИмяТипПо умолчанию
propertyStringName—
PropertyKeyedWithValueСобытие
# PropertyKeyedWithValue
C#
public event EditorProperty.PropertyKeyedWithValueEventHandler PropertyKeyedWithValue;

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

Параметры обработчика
ИмяТипПо умолчанию
propertyStringName—
valueVariant—
PropertyOverriddenСобытие
# PropertyOverridden
C#
public event Action PropertyOverridden;

Выдает при запросе переопределения настроек для текущего проекта.

PropertyPinnedСобытие
# PropertyPinned
C#
public event EditorProperty.PropertyPinnedEventHandler PropertyPinned;

Выдайте его, если вы хотите пометить (или снять пометку) значение свойства для сохранения независимо от того, равно ли оно значению по умолчанию. Значение по умолчанию — это то, которое свойство получит, когда узел только что инстанцируется, и может быть получено из родительской сцены в цепочке наследования/инстанцирования, скрипта или встроенного класса.

Параметры обработчика
ИмяТипПо умолчанию
propertyStringName—
pinnedbool—
ResourceSelectedСобытие
# ResourceSelected
C#
public event EditorProperty.ResourceSelectedEventHandler ResourceSelected;

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

Параметры обработчика
ИмяТипПо умолчанию
pathstring—
resourceResource—
SelectedСобытие
# Selected
C#
public event EditorProperty.SelectedEventHandler Selected;

Выдается при выборе. Используется внутри.

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

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

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

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