ObjectField
UnityEditor.UIElements.ObjectField
읽는 시간 2분최근 업데이트: 4일 전
An ObjectField is an Editor-only element that lets users select a Unity object from a list of available objects. You can use it to select a Unity object to use as a reference, such as a material, a texture, a script, or a GameObject.
참고
To align an element with other fields in an Inspector window, simply apply the USS class to it. For more information, refer to .
.unity-base-field__alignedBaseFieldCreate an ObjectField
You can create an ObjectField with UI Builder, UXML, or C#.
To create an ObjectField in UI Builder, you must first enable Editor Extension Authoring for UI Documents (UXML) so that the ObjectField element is available in the Library panel.
To restrict the type of objects that can be selected, use the property. In UXML, the format of the property is .
typetypeType Name, Type assembly name팁
To find the assembly name of a type, use or find it in the type's Script API page.
Debug.Log(theType.AssemblyQualifiedName);The following examples create an ObjectField for selecting a 2D texture:
UXML:
<ObjectField type="UnityEngine.Texture2D, UnityEngine.CoreModule" label="Select an object:" />
C#:
using UnityEditor.UIElements;...var objectField = new ObjectField();objectField.objectType = typeof(Texture2D);objectField.label = "Select an object:";
Example
The following UXML example creates an ObjectField:
<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements"> <uie:ObjectField label="UXML Field" name="the-uxml-field" /></UXML>
The following USS example styles the ObjectField:
.some-styled-field { -unity-font-style: bold;}.some-styled-field .unity-base-field__input { -unity-font-style: italic;}
The following C# example illustrates some of the customizable functionalities of the ObjectField:
// Get a reference to the field from UXML and assign a value to it. var uxmlField = container.Q<ObjectField>("the-uxml-field"); uxmlField.value = new Texture2D(10, 10) { name = "new_texture" }; // Create a new field, disable it, and give it a style class. var csharpField = new ObjectField("C# Field"); csharpField.SetEnabled(false); csharpField.AddToClassList("some-styled-field"); csharpField.value = uxmlField.value; container.Add(csharpField); // Mirror the value of the UXML field into the C# field. uxmlField.RegisterCallback<ChangeEvent<Object>>((evt) => { csharpField.value = evt.newValue; });
To try this example live in Unity, go to Window > UI Toolkit > Samples.
C# base class and namespace
C# class:
ObjectFieldNamespace:
UnityEditor.UIElementsBase class:
BaseField_1Member UXML attributes
This element has the following member attributes:
Name | Type | Description |
|---|---|---|
| | Allows scene objects to be assigned to the field. |
| | The type of the objects that can be assigned. |
Inherited UXML attributes
This element inherits the following attributes from its base class:
Name | Type | Description |
|---|---|---|
| | Path of the target property to be bound. |
| | Whether an element can potentially receive focus. If false, the element can't receive focus. If true, the element receives focus only when its |
| | The string representing the label that will appear beside the field. If the string is empty, the label element is removed from the hierarchy. If the string is not empty, the label element is added to the hierarchy. |
| | An integer used to sort focusable elements in the focus ring. Must be greater than or equal to zero. Setting the |
| | The value associated with the field. |
This element also inherits the following attributes from :
VisualElementName | Type | Description |
|---|---|---|
| | Logical container where child elements are added. If a child is added to this element, the child is added to this element's content container instead. When iterating over the If the content container is the same as the element itself, child elements are added directly to the element. This is true for most elements but can be overridden by more complex types. The |
| | Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children. |
| | Path from the data source to the value. |
| | 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. |
| | Returns true if the This flag isn't changed if the VisualElement is disabled implicitly by one of its parents. To verify this, use |
| | Indicates the directionality of the element's text. The value will propagate to the element's children. |
| | 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. |
| | Determines if this element can be the target of pointer events or picked by Elements can not be picked if: - They are invisible- Their Elements with a picking mode of |
| | Sets the style values on a The returned style data, computed from USS files or inline styles written to this object in C#, doesn't represent the fully resolved styles, such as the final height and width of a VisualElement. To access these fully resolved styles, use For information about how to use this property and all the supported USS properties, refer to the Apply styles in C# scripts and USS properties reference manual pages. |
| | 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. |
| | A combination of hint values that specify high-level intended usage patterns for the |
| | 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 |
USS classes
The following table lists all the C# public property names and their related USS selector.
C# property | USS selector | Description |
|---|---|---|
| | USS class name of elements of this type. |
| | USS class name of labels in elements of this type. |
| | USS class name of input elements in elements of this type. |
| | USS class name of object elements in elements of this type. |
| | USS class name of selector elements in elements of this type. |
| | USS class name of elements of this type. |
| | USS class name of labels in elements of this type. |
| | USS class name of input elements in elements of this type. |
| | USS class name of elements of this type, when there is no label. |
| | USS class name of labels in elements of this type, when there is a dragger attached on them. |
| | USS class name of elements that show mixed values |
| | USS class name of elements that are aligned in a inspector element |
| | 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 at every level of its hierarchy.
VisualElement