EditorProperty
Пользовательский элемент управления для редактирования свойств, который можно добавить в EditorInspector.
Пользовательский элемент управления для редактирования свойств, который можно добавить в EditorInspector.
Пользовательский элемент управления для редактирования свойств, который можно добавить в EditorInspector. Он добавляется через EditorInspectorPlugin.
Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.
Конструкторы1
EditorPropertyКонструктор
public EditorProperty();Свойства12
CheckableСвойство
public bool Checkable { get; set; }Используется инспектором, устанавливается в true, когда свойство можно проверить.
CheckedСвойство
public bool Checked { get; set; }Используется инспектором, устанавливается в true при проверке свойства.
DeletableСвойство
public bool Deletable { get; set; }Используется инспектором, устанавливается в true, когда свойство может быть удалено пользователем.
DrawBackgroundСвойство
public bool DrawBackground { get; set; }Используется инспектором, устанавливается в true при прорисовке фона свойства.
DrawLabelСвойство
public bool DrawLabel { get; set; }Используется инспектором, устанавливается в true при рисовании метки свойства.
DrawWarningСвойство
public bool DrawWarning { get; set; }Используется инспектором, устанавливается в true, когда свойство отображается с предупреждающим цветом темы редактора. Используется для редактируемых дочерних свойств.
KeyingСвойство
public bool Keying { get; set; }Используется инспектором, устанавливается в true, когда свойство может добавлять ключи для анимации.
LabelСвойство
public string Label { get; set; }Установите это свойство, чтобы изменить метку (если вы хотите ее отобразить).
NameSplitRatioСвойство
public float NameSplitRatio { get; set; }Соотношение распределения пространства между меткой и полем редактирования.
ReadOnlyСвойство
public bool ReadOnly { get; set; }Используется инспектором, устанавливается в true, когда свойство доступно только для чтения.
SelectableСвойство
public bool Selectable { get; set; }Используется инспектором, устанавливается в true, когда свойство можно выбрать.
UseFoldingСвойство
public bool UseFolding { get; set; }Используется инспектором, устанавливается в true, когда свойство использует свертывание.
Методы37
AddFocusablevoid
public void AddFocusable(Control control);Если какой-либо из добавленных элементов управления может получить фокус клавиатуры, добавьте его здесь. Это гарантирует, что фокус будет восстановлен при обновлении инспектора.
| Имя | Тип | По умолчанию |
|---|---|---|
control | Control | — |
Deselectvoid
public void Deselect();Рисовать свойство как не выбранное. Используется инспектором.
EmitChangedvoid
public void EmitChanged(StringName property, Variant value, StringName field = null, bool changing = false);Сообщает Inspector о пользовательском изменении. Не заменяйте прямым присваиванием, если нужен редакторский путь изменения и Undo/Redo. Не вызывайте из обычного обновления виджета по модели.
| Имя | Тип | По умолчанию |
|---|---|---|
property | StringName | — |
value | Variant | — |
field | StringName | null |
changing | bool | false |
propertyИмя изменяемого свойства, обычно GetEditedProperty().
valueНовое Variant-совместимое значение, а не сам виджет.
fieldНеобязательное имя подкомпонента; для изменения свойства целиком пример оставляет пустым.
changingФлаг непрерывного изменения, например во время набора текста. Пример завершённого числового шага использует false; жесты перетаскивания не проверялись.
GetEditedObjectReckfellObject
public ReckfellObject GetEditedObject();Читает объект, назначенный этому EditorProperty Inspector. Для начального обновления и смены выбора проверяйте наличие объекта перед Get.
ReckfellObjectТекущий ReckfellObject либо null. В проверке это тот же DocsInspectorSettings, который открыт в главном Inspector.
GetEditedPropertyStringName
public StringName GetEditedProperty();Читает имя свойства, привязанного Inspector к этому виджету. Используйте для Get и EmitChanged вместо жёстко заданного имени другого поля.
StringNameStringName привязанного свойства; проверено Amount. Это не отображаемая подпись Label.
GetLabelstring
public string GetLabel();stringGetNameSplitRatiofloat
public float GetNameSplitRatio();floatIsCheckablebool
public bool IsCheckable();boolIsCheckedbool
public bool IsChecked();boolIsDeletablebool
public bool IsDeletable();boolIsDrawBackgroundbool
public bool IsDrawBackground();boolIsDrawLabelbool
public bool IsDrawLabel();boolIsDrawWarningbool
public bool IsDrawWarning();boolIsKeyingbool
public bool IsKeying();boolIsReadOnlybool
public bool IsReadOnly();boolIsSelectablebool
public bool IsSelectable();boolIsSelectedbool
public bool IsSelected();Возвращает true, если свойство нарисовано как выбранное. Используется инспектором.
boolIsUsingFoldingbool
public bool IsUsingFolding();boolSelectvoid
public void Select(int focusable = -1);Свойство рисования выбрано. Используется инспектором.
| Имя | Тип | По умолчанию |
|---|---|---|
focusable | int | -1 |
SetBottomEditorvoid
public void SetBottomEditor(Control editor);Размещает элемент управления editor под меткой свойства. Элемент управления должен быть предварительно добавлен с помощью Entity.AddChild.
| Имя | Тип | По умолчанию |
|---|---|---|
editor | Control | — |
SetCheckablevoid
public void SetCheckable(bool checkable);| Имя | Тип | По умолчанию |
|---|---|---|
checkable | bool | — |
SetCheckedvoid
public void SetChecked(bool @checked);| Имя | Тип | По умолчанию |
|---|---|---|
checked | bool | — |
SetDeletablevoid
public void SetDeletable(bool deletable);| Имя | Тип | По умолчанию |
|---|---|---|
deletable | bool | — |
SetDrawBackgroundvoid
public void SetDrawBackground(bool drawBackground);| Имя | Тип | По умолчанию |
|---|---|---|
drawBackground | bool | — |
SetDrawLabelvoid
public void SetDrawLabel(bool drawLabel);| Имя | Тип | По умолчанию |
|---|---|---|
drawLabel | bool | — |
SetDrawWarningvoid
public void SetDrawWarning(bool drawWarning);| Имя | Тип | По умолчанию |
|---|---|---|
drawWarning | bool | — |
SetKeyingvoid
public void SetKeying(bool keying);| Имя | Тип | По умолчанию |
|---|---|---|
keying | bool | — |
SetLabelvoid
public void SetLabel(string text);| Имя | Тип | По умолчанию |
|---|---|---|
text | string | — |
SetLabelReferencevoid
public void SetLabelReference(Control control);Используется инспектором, задает элемент управления, который будет использоваться в качестве эталона для расчета размера этикетки.
| Имя | Тип | По умолчанию |
|---|---|---|
control | Control | — |
SetNameSplitRatiovoid
public void SetNameSplitRatio(float ratio);| Имя | Тип | По умолчанию |
|---|---|---|
ratio | float | — |
SetObjectAndPropertyvoid
public void SetObjectAndProperty(ReckfellObject @object, StringName property);Назначает объект и свойство для редактирования.
| Имя | Тип | По умолчанию |
|---|---|---|
object | ReckfellObject | — |
property | StringName | — |
SetReadOnlyvoid
public void SetReadOnly(bool readOnly);Вызывается при изменении статуса свойства «только для чтения». Может использоваться для изменения пользовательских элементов управления в состояние «только для чтения» или «изменяемое».
###обновленное
| Имя | Тип | По умолчанию |
|---|---|---|
readOnly | bool | — |
SetSelectablevoid
public void SetSelectable(bool selectable);| Имя | Тип | По умолчанию |
|---|---|---|
selectable | bool | — |
SetUseFoldingvoid
public void SetUseFolding(bool useFolding);| Имя | Тип | По умолчанию |
|---|---|---|
useFolding | bool | — |
UpdatePropertyvoid
public void UpdateProperty();При вызове этой виртуальной функции вам необходимо обновить свой редактор.
_SetReadOnlyvoid
public virtual void _SetReadOnly(bool readOnly);Callback для синхронизации собственных элементов с режимом только чтения. Недостаточно изменить внешний вид: блокируйте и обработчик, посылающий EmitChanged.
| Имя | Тип | По умолчанию |
|---|---|---|
readOnly | bool | — |
readOnlytrue запрещает изменение через ваш интерфейс; false возвращает обычное редактирование.
_UpdatePropertyvoid
public virtual void _UpdateProperty();Обновляет интерфейс из текущего состояния модели. В переопределении читайте GetEditedObject/GetEditedProperty и задавайте виджет без сигнала изменения; пример использует SetValueNoSignal.
Сигналы и события13
MultiplePropertiesChangedСобытие
public event EditorProperty.MultiplePropertiesChangedEventHandler MultiplePropertiesChanged;Выдайте его, если хотите, чтобы несколько свойств были изменены одновременно. Не используйте, если добавлено через EditorInspectorPlugin._ParseProperty.
| Имя | Тип | По умолчанию |
|---|---|---|
properties | string[] | — |
value | Reckfell.Collections.Array | — |
ObjectIdSelectedСобытие
public event EditorProperty.ObjectIdSelectedEventHandler ObjectIdSelected;Используется подинспекторами. Object ID.
| Имя | Тип | По умолчанию |
|---|---|---|
property | StringName | — |
id | long | — |
PropertyCanRevertChangedСобытие
public event EditorProperty.PropertyCanRevertChangedEventHandler PropertyCanRevertChanged;Генерируется, когда изменилась возможность возврата (т. е. имеет ли свойство значение, отличное от значения по умолчанию, и поэтому отображается со значком возврата).
| Имя | Тип | По умолчанию |
|---|---|---|
property | StringName | — |
canRevert | bool | — |
PropertyChangedСобытие
public event EditorProperty.PropertyChangedEventHandler PropertyChanged;Не вызывайте его вручную, вместо этого используйте метод EditorProperty.EmitChanged.
| Имя | Тип | По умолчанию |
|---|---|---|
property | StringName | — |
value | Variant | — |
field | StringName | — |
changing | bool | — |
PropertyCheckedСобытие
public event EditorProperty.PropertyCheckedEventHandler PropertyChecked;Выдается при проверке свойства. Используется внутри.
| Имя | Тип | По умолчанию |
|---|---|---|
property | StringName | — |
checked | bool | — |
PropertyDeletedСобытие
public event EditorProperty.PropertyDeletedEventHandler PropertyDeleted;Выдается при удалении свойства. Используется внутри.
| Имя | Тип | По умолчанию |
|---|---|---|
property | StringName | — |
PropertyFavoritedСобытие
public event EditorProperty.PropertyFavoritedEventHandler PropertyFavorited;Используйте его, если вы хотите отметить свойство как избранное и отобразить его в верхней части инспектора.
| Имя | Тип | По умолчанию |
|---|---|---|
property | StringName | — |
favorited | bool | — |
PropertyKeyedСобытие
public event EditorProperty.PropertyKeyedEventHandler PropertyKeyed;Выдайте его, если вы хотите добавить это значение в качестве ключа анимации (сначала проверьте, включено ли ключевое воздействие).
| Имя | Тип | По умолчанию |
|---|---|---|
property | StringName | — |
PropertyKeyedWithValueСобытие
public event EditorProperty.PropertyKeyedWithValueEventHandler PropertyKeyedWithValue;Используйте его, если вы хотите присвоить свойству ключ с одним значением.
| Имя | Тип | По умолчанию |
|---|---|---|
property | StringName | — |
value | Variant | — |
PropertyOverriddenСобытие
public event Action PropertyOverridden;Выдает при запросе переопределения настроек для текущего проекта.
PropertyPinnedСобытие
public event EditorProperty.PropertyPinnedEventHandler PropertyPinned;Выдайте его, если вы хотите пометить (или снять пометку) значение свойства для сохранения независимо от того, равно ли оно значению по умолчанию. Значение по умолчанию — это то, которое свойство получит, когда узел только что инстанцируется, и может быть получено из родительской сцены в цепочке наследования/инстанцирования, скрипта или встроенного класса.
| Имя | Тип | По умолчанию |
|---|---|---|
property | StringName | — |
pinned | bool | — |
ResourceSelectedСобытие
public event EditorProperty.ResourceSelectedEventHandler ResourceSelected;Если вы хотите, чтобы подресурс был отредактирован, отправьте этот сигнал вместе с ресурсом.
| Имя | Тип | По умолчанию |
|---|---|---|
path | string | — |
resource | Resource | — |
SelectedСобытие
public event EditorProperty.SelectedEventHandler Selected;Выдается при выборе. Используется внутри.
| Имя | Тип | По умолчанию |
|---|---|---|
path | string | — |
focusableIdx | long | — |