EditorProperty

public bool Checkable { get; set; }

Used by the inspector, set to true when the property is checkable.

public bool Checked { get; set; }

Used by the inspector, set to true when the property is checked.

public bool Deletable { get; set; }

Used by the inspector, set to true when the property can be deleted by the user.

public bool DrawBackground { get; set; }

Used by the inspector, set to true when the property background is drawn.

public bool DrawLabel { get; set; }

Used by the inspector, set to true when the property label is drawn.

public bool DrawWarning { get; set; }

Used by the inspector, set to true when the property is drawn with the editor theme's warning color. This is used for editable children's properties.

public bool Keying { get; set; }

Used by the inspector, set to true when the property can add keys for animation.

public string Label { get; set; }

Set this property to change the label (if you want to show one).

public float NameSplitRatio { get; set; }

Space distribution ratio between the label and the editing field.

public bool ReadOnly { get; set; }

Used by the inspector, set to true when the property is read-only.

public bool Selectable { get; set; }

Used by the inspector, set to true when the property is selectable.

public bool UseFolding { get; set; }

Used by the inspector, set to true when the property is using folding.

public void AddFocusable(Control control);

If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed.

public void Deselect();

Draw property as not selected. Used by the inspector.

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

Reports a user edit to Inspector. Do not replace with direct assignment when editor change handling and Undo/Redo are needed. Do not call merely to refresh a widget from model data.

public ReckfellObject GetEditedObject();

Reads the object assigned to this EditorProperty by Inspector. Check for an object before Get during initialization or selection changes.

public StringName GetEditedProperty();

Reads the property name bound to this widget by Inspector. Use for Get and EmitChanged rather than hardcoding another field.

public bool IsSelected();

Returns true if property is drawn as selected. Used by the inspector.

public void Select(int focusable = -1);

Draw property as selected. Used by the inspector.

public void SetBottomEditor(Control editor);

Puts the editor control below the property label. The control must be previously added using Entity.AddChild.

public void SetLabelReference(Control control);

Used by the inspector, set to a control that will be used as a reference to calculate the size of the label.

public void SetObjectAndProperty(ReckfellObject @object, StringName property);

Assigns object and property to edit.

public void SetReadOnly(bool readOnly);

Called when the read-only status of the property is changed. It may be used to change custom controls into a read-only or modifiable state.

public void UpdateProperty();

When this virtual function is called, you must update your editor.

public virtual void _SetReadOnly(bool readOnly);

Callback for synchronizing custom controls with read-only mode. Appearance alone is insufficient: also guard the handler that emits changes.

public virtual void _UpdateProperty();

Refreshes UI from current model state. Read GetEditedObject/GetEditedProperty and update without an edit signal; the example uses SetValueNoSignal.

public event EditorProperty.MultiplePropertiesChangedEventHandler MultiplePropertiesChanged;

Emit it if you want multiple properties modified at the same time. Do not use if added via EditorInspectorPlugin._ParseProperty.

public event EditorProperty.ObjectIdSelectedEventHandler ObjectIdSelected;

Used by sub-inspectors. Emit it if what was selected was an Object ID.

public event EditorProperty.PropertyCanRevertChangedEventHandler PropertyCanRevertChanged;

Emitted when the revertability (i.e., whether it has a non-default value and thus is displayed with a revert icon) of a property has changed.

public event EditorProperty.PropertyChangedEventHandler PropertyChanged;

Do not emit this manually, use the EditorProperty.EmitChanged method instead.

public event EditorProperty.PropertyCheckedEventHandler PropertyChecked;

Emitted when a property was checked. Used internally.

public event EditorProperty.PropertyDeletedEventHandler PropertyDeleted;

Emitted when a property was deleted. Used internally.

public event EditorProperty.PropertyFavoritedEventHandler PropertyFavorited;

Emit it if you want to mark a property as favorited, making it appear at the top of the inspector.

public event EditorProperty.PropertyKeyedEventHandler PropertyKeyed;

Emit it if you want to add this value as an animation key (check for keying being enabled first).

public event EditorProperty.PropertyKeyedWithValueEventHandler PropertyKeyedWithValue;

Emit it if you want to key a property with a single value.

public event Action PropertyOverridden;

Emitted when a setting override for the current project is requested.

public event EditorProperty.PropertyPinnedEventHandler PropertyPinned;

Emit it if you want to mark (or unmark) the value of a property for being saved regardless of being equal to the default value. The default value is the one the property will get when the node is just instantiated and can come from an ancestor scene in the inheritance/instantiation chain, a script or a builtin class.

public event EditorProperty.ResourceSelectedEventHandler ResourceSelected;

If you want a sub-resource to be edited, emit this signal with the resource.

public event EditorProperty.SelectedEventHandler Selected;

Emitted when selected. Used internally.