An InspectorElement is a UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary control that displays the properties of a SerializedObject in the InspectorA Unity window that displays information about the currently selected GameObject, asset or project settings, allowing you to inspect and edit the values. More info
See in Glossary window. You can use it to display the properties of a SerializedObject in a custom Editor window.
You can create an InspectorElement with UXML or C#. The following C# example creates an InspectorElement and binds it to a SerializedObject:
using UnityEditor.UIElements;
...
var inspectorElement = new InspectorElement();
var serializedObject = new SerializedObject(myObject);
inspectorElement.Bind(serializedObject);
C# class: InspectorElement
Namespace: UnityEditor.UIElements
Base class: BindableElement
This element inherits the following attributes from its base class:
| Name | Type | Description |
|---|---|---|
binding-path |
string |
Path of the target property to be bound. |
focusable |
boolean |
True if the element can be focused. |
tabindex |
int |
An integer used to sort focusables in the focus ring. Must be greater than or equal to zero. |
This element also inherits the following attributes from VisualElement:
| Name | Type | Description |
|---|---|---|
content-container |
string |
Child elements are added to it, usually this is the same as the element itself. |
data-source |
Object |
Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children. |
data-source-path |
string |
Path from the data source to the value. |
data-source-type |
System.Type |
The possible type of data source assignable to this VisualElement. This information is only used by the UI Builder as a hint to provide some completion to the data source path field when the effective data source cannot be specified at design time. |
language-direction |
UIElements.LanguageDirection |
Indicates the directionality of the element’s text. The value will propagate to the element’s children. Setting the languageDirection to RTL adds basic support for right-to-left (RTL) by reversing the text and handling linebreaking and word wrapping appropriately. However, it does not provide comprehensive RTL support, as this would require text shaping, which includes the reordering of characters, and OpenType font feature support. Comprehensive RTL support is planned for future updates, which will involve additional APIs to handle language, script, and font feature specifications. To enhance the RTL functionality of this property, users can explore available third-party plugins in the Unity Asset Store and make use of ITextElementExperimentalFeatures.renderedText
|
name |
string |
The name of this VisualElement. Use this property to write USS selectors that target a specific element. The standard practice is to give an element a unique name. |
picking-mode |
UIElements.PickingMode |
Determines if this element can be pick during mouseEvents or IPanel.Pick queries. |
style |
string |
Sets the VisualElement style values. |
tooltip |
string |
Text to display inside an information box after the user hovers the element for a small amount of time. This is only supported in the Editor UI. |
usage-hints |
UIElements.UsageHints |
A combination of hint values that specify high-level intended usage patterns for the VisualElement. This property can only be set when the VisualElement is not yet part of a Panel. Once part of a Panel, this property becomes effectively read-only, and attempts to change it will throw an exception. The specification of proper UsageHints drives the system to make better decisions on how to process or accelerate certain operations based on the anticipated usage pattern. Note that those hints do not affect behavioral or visual results, but only affect the overall performance of the panel and the elements within. It’s advised to always consider specifying the proper UsageHints, but keep in mind that some UsageHints might be internally ignored under certain conditions (e.g. due to hardware limitations on the target platform). |
view-data-key |
string |
Used for view data persistence, such as tree expanded states, scroll position, or zoom level. This key is used to save and load the view data from the view data store. If you don’t set this key, the persistence is disabled for the associated VisualElement. For more information, refer to View data persistence. |
The following table lists all the C# public property names and their related USS selector.
| C# property | USS selector | Description |
|---|---|---|
ussClassName |
.unity-inspector-element |
USS class name of elements of this type. |
customInspectorUssClassName |
.unity-inspector-element__custom-inspector-container |
USS class name of custom inspector elements in elements of this type. |
iMGUIContainerUssClassName |
.unity-inspector-element__imgui-container |
USS class name of IMGUI containers in elements of this type. |
iMGUIInspectorVariantUssClassName |
.unity-inspector-element--imgui |
USS class name of elements of this type, when they are displayed in IMGUI inspector mode. |
uIEInspectorVariantUssClassName |
.unity-inspector-element--uie |
USS class name of elements of this type, when they are displayed in UIElements inspector mode. |
noInspectorFoundVariantUssClassName |
.unity-inspector-element--no-inspector-found |
USS class name of elements of this type, when no inspector is found. |
uIECustomVariantUssClassName |
.unity-inspector-element--uie-custom |
USS class name of elements of this type, when they are displayed in UIElements custom mode. |
iMGUICustomVariantUssClassName |
.unity-inspector-element--imgui-custom |
USS class name of elements of this type, when they are displayed in IMGUI custom mode. |
iMGUIDefaultVariantUssClassName |
.unity-inspector-element--imgui-default |
USS class name of elements of this type, when they are displayed in IMGUI default mode. |
uIEDefaultVariantUssClassName |
.unity-inspector-element--uie-default |
USS class name of elements of this type, when they are displayed in UIElements default mode. |
debugVariantUssClassName |
.unity-inspector-element--debug |
USS class name of elements of this type, when they are displayed in debug USS mode. |
debugInternalVariantUssClassName |
.unity-inspector-element--debug-internal |
USS class name of elements of this type, when they are displayed in debug internal mode. |
disabledUssClassName |
.unity-disabled |
USS class name of local disabled elements. |
You can also use the Matching Selectors section in the Inspector or the UI Toolkit Debugger to see which USS selectors affect the components of the VisualElement at every level of its hierarchy.