Version: 2021.3+
This example demonstrates how to create a bindable custom control in a custom Editor window.
This example creates a custom control bound to a property with the double data type. You can adapt this example to bind to properties with other data types such as a string or an integer.
You can find the completed files that this example creates in this GitHub repository.
This guide is for developers familiar with the Unity Editor, UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary Toolkit, and C# scripting. Before you start, get familiar with the following:
Create a C# class to define the custom control.
Create a Unity project with any template.
Create a folder named ExampleField
to store your files.
In the ExampleField
folder, create a C# script named ExampleField.cs
and replace its content with the following:
using UnityEngine.UIElements;
namespace UIToolkitExamples
{
// ExampleField inherits from BaseField with the double type. Therefoe, the ExampleField's underlying value is a double.
public class ExampleField : BaseField<double>
{
// We can provide the existing BaseFieldTraits class as a type parameter for UxmlFactory, and this means we
// don't need to define our own traits class or override its Init() method. We do, however, need to provide it
// However, you must provide the value type (double) and its attribute description type:
// (UxmlDoubleAttributeDescription).
public new class UxmlFactory :
UxmlFactory<ExampleField, BaseFieldTraits<double, UxmlDoubleAttributeDescription>> { }
Label m_Input;
// Default constructor is required for compatibility with UXML factory
public ExampleField() : this(null)
{
}
// Main constructor accepts label parameter to mimic BaseField constructor.
// Second argument to base constructor is the input element, the one that displays the value this field is
// bound to.
public ExampleField(string label) : base(label, new Label() { })
{
// This is the input element instantiated for the base constructor.
m_Input = this.Q<Label>(className: inputUssClassName);
}
// SetValueWithoutNotify needs to be overridden by calling the base version and then making a change to the
// underlying value be reflected in the input element.
public override void SetValueWithoutNotify(double newValue)
{
base.SetValueWithoutNotify(newValue);
m_Input.text = value.ToString("N");
}
}
}
In the ExampleField
folder, create a UI Document named ExampleField.uxml
.
Open ExampleField.uxml
in a text editor and replace its contents with the following:
<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:example="UIToolkitExamples">
<example:ExampleField label="Binding Target" binding-path="m_Value" />
</ui:UXML>
In Unity, double-click ExampleField.uxml
to open it in the UI Builder. The ExampleField displays in the Hierarchy window and is visualized in the ViewportThe user’s visible area of an app on their screen.
See in Glossary. If you select the ExampleField in the Hierarchy window, 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 shows the values assigned to the Binding Path and Label boxes.
In the ExampleField
folder, create a C# script named ExampleFieldComponent.cs
and replace its contents with the following:
using UnityEngine;
namespace UIToolkitExamples
{
public class ExampleFieldComponent : MonoBehaviour
{
[SerializeField]
double m_Value;
}
}
In the ExampleField
folder, create a folder named Editor
.
In the Editor
folder, create a C# script named ExampleFieldCustomEditor.cs
and replace its contents with the following:
using UnityEditor;
using UnityEngine.UIElements;
using UnityEngine;
namespace UIToolkitExamples
{
[CustomEditor(typeof(ExampleFieldComponent))]
public class ExampleFieldCustomEditor : Editor
{
[SerializeField]
VisualTreeAsset m_Uxml;
public override VisualElement CreateInspectorGUI()
{
var parent = new VisualElement();
m_Uxml?.CloneTree(parent);
return parent;
}
}
}
In Unity, select ExampleFieldCustomEditor.cs
in the Project windowA window that shows the contents of your Assets
folder (Project tab) More info
See in Glossary.
Drag ExampleField.uxml
into the Uxml box in the Inspector window.
ExampleFieldComponent
component to the GameObject. The custom control appears in the Inspector with the default value of 0
for the Binding Target. If you change the value of the underlying double property, the UI reflects that change.When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.