EditorInspector
A control used to edit properties of an object.
A control used to edit properties of an object.
This is the control that implements property editing in the editor's Settings dialogs, the Inspector dock, etc. To get the EditorInspector used in the editor's Inspector dock, use EditorInterface.GetInspector.
EditorInspector will show properties in the same order as the array returned by ReckfellObject.GetPropertyList.
If a property's name is path-like (i.e. if it contains forward slashes), EditorInspector will create nested sections for "directories" along the path. For example, if a property is named highlighting/csharp/entity_path_color, it will be shown as "Entity Path Color" inside the "C#" section nested inside the "Highlighting" section.
If a property has PROPERTY_USAGE_GROUP usage, it will group subsequent properties whose name starts with the property's hint string. The group ends when a property does not start with that hint string or when a new group starts. An empty group name effectively ends the current group. EditorInspector will create a top-level section for each group. For example, if a property with group usage is named Collide With and its hint string is collide_with_, a subsequent collide_with_area property will be shown as "Area" inside the "Collide With" section. There is also a special case: when the hint string contains the name of a property, that property is grouped too. This is mainly to help grouping properties like font, font_color and font_size (using the hint string font_).
If a property has PROPERTY_USAGE_SUBGROUP usage, a subgroup will be created in the same way as a group, and a second-level section will be created for each subgroup.
Note: Unlike sections created from path-like property names, EditorInspector won't capitalize the name for sections created from groups. So properties with group usage usually use capitalized names instead of snake_cased names.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
EditorInspectorConstructor
public EditorInspector();Methods10
CollapseAllFoldingvoid
public void CollapseAllFolding();Collapses all foldable sections.
CreateDefaultInspectorEditorInspector
public static EditorInspector CreateDefaultInspector(LineEdit filterLineEdit = null);Creates an inspector with the same configuration as the one used in the editor's Inspector dock. When passing a LineEdit into filter_line_edit, the inspector will filter its properties based on LineEdit.Text whenever LineEdit.TextChanged is emitted.
| Name | Type | Default |
|---|---|---|
filterLineEdit | LineEdit | null |
EditorInspectorEditvoid
public void Edit(ReckfellObject @object);Shows the properties of the given object in this inspector for editing. To clear the inspector, call this method with null.
Note: If you want to edit an object in the editor's main inspector, use the edit_* methods in EditorInterface instead.
| Name | Type | Default |
|---|---|---|
object | ReckfellObject | — |
ExpandAllFoldingvoid
public void ExpandAllFolding();Expands all foldable sections.
ExpandRevertablevoid
public void ExpandRevertable();Expands only the foldable sections that contain a revertable (i.e. non-default) property.
GetEditedObjectReckfellObject
public ReckfellObject GetEditedObject();Returns the object currently selected in this inspector.
ReckfellObjectGetPropertyClipboardVariant
public static Variant GetPropertyClipboard();Gets the value currently in the property clipboard.
VariantGetSelectedPathstring
public string GetSelectedPath();Gets the path of the currently selected property.
stringInstantiatePropertyEditorEditorProperty
public static EditorProperty InstantiatePropertyEditor(ReckfellObject @object, Variant.Type type, string path, PropertyHint hint, string hintText, uint usage, bool wide = false);Creates a property editor that can be used by plugin UI to edit the specified property of an object.
| Name | Type | Default |
|---|---|---|
object | ReckfellObject | — |
type | Variant.Type | — |
path | string | — |
hint | PropertyHint | — |
hintText | string | — |
usage | uint | — |
wide | bool | false |
EditorPropertySetPropertyClipboardvoid
public static void SetPropertyClipboard(Variant value);Sets the property clipboard's content to the given value.
| Name | Type | Default |
|---|---|---|
value | Variant | — |
Signals and events9
EditedObjectChangedEvent
public event Action EditedObjectChanged;Emitted when the object being edited by the inspector has changed.
ObjectIdSelectedEvent
public event EditorInspector.ObjectIdSelectedEventHandler ObjectIdSelected;Emitted when the Edit button of an ReckfellObject has been pressed in the inspector. This is mainly used in the remote scene tree Inspector.
| Name | Type | Default |
|---|---|---|
id | long | — |
PropertyDeletedEvent
public event EditorInspector.PropertyDeletedEventHandler PropertyDeleted;Emitted when a property is removed from the inspector.
| Name | Type | Default |
|---|---|---|
property | string | — |
PropertyEditedEvent
public event EditorInspector.PropertyEditedEventHandler PropertyEdited;Emitted when a property is edited in the inspector.
| Name | Type | Default |
|---|---|---|
property | string | — |
PropertyKeyedEvent
public event EditorInspector.PropertyKeyedEventHandler PropertyKeyed;Emitted when a property is keyed in the inspector. Properties can be keyed by clicking the "key" icon next to a property when the Animation panel is toggled.
| Name | Type | Default |
|---|---|---|
property | string | — |
value | Variant | — |
advance | bool | — |
PropertySelectedEvent
public event EditorInspector.PropertySelectedEventHandler PropertySelected;Emitted when a property is selected in the inspector.
| Name | Type | Default |
|---|---|---|
property | string | — |
PropertyToggledEvent
public event EditorInspector.PropertyToggledEventHandler PropertyToggled;Emitted when a boolean property is toggled in the inspector.
Note: This signal is never emitted if the internal autoclear property enabled. Since this property is always enabled in the editor inspector, this signal is never emitted by the editor itself.
| Name | Type | Default |
|---|---|---|
property | string | — |
checked | bool | — |
ResourceSelectedEvent
public event EditorInspector.ResourceSelectedEventHandler ResourceSelected;Emitted when a resource is selected in the inspector.
| Name | Type | Default |
|---|---|---|
resource | Resource | — |
path | string | — |
RestartRequestedEvent
public event Action RestartRequested;Emitted when a property that requires a restart to be applied is edited in the inspector. This is only used in the Project Settings and Editor Settings.