Version: 2021.3+
This example demonstrates how to receive callbacks when a bound serialized property changes.
This example creates a custom Editor window with a TextField that binds to the name of a GameObjectThe fundamental object in Unity scenes, which can represent characters, props, scenery, cameras, waypoints, and more. A GameObject’s functionality is defined by the Components attached to it. More info
See in Glossary in a sceneA Scene contains the environments and menus of your game. Think of each unique Scene file as a unique level. In each Scene, you place your environments, obstacles, and decorations, essentially designing and building your game in pieces. More info
See in Glossary. If the name of the GameObject is GameObject
, the background color of the text field label changes to dark red.
You can find the completed files for the example 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# script that:
CheckName()
method whenever the value of a serialized property changesTrackPropertyValue()
extension methodUnbind()
before calling the TrackPropertyValue()
again on another property.A VisualElement
can only track one property at any given time.
Create a project in Unity with any template.
In your Project windowA window that shows the contents of your Assets
folder (Project tab) More info
See in Glossary, create a folder named callback-SerializedProperty-changes
to store your files.
In the callback-SerializedProperty-change folder, create a folder named Editor
.
In the Editor folder, create a C# script named SimpleBindingPropertyTrackingExample.cs
and replace its contents with the following:
using UnityEditor;
using UnityEngine;
using UnityEditor.UIElements;
using UnityEngine.UIElements;
namespace UIToolkitExamples
{
public class SimpleBindingPropertyTrackingExample : EditorWindow
{
TextField m_ObjectNameBinding;
[MenuItem("Window/UIToolkitExamples/Simple Binding Property Tracking Example")]
public static void ShowDefaultWindow()
{
var wnd = GetWindow<SimpleBindingPropertyTrackingExample>();
wnd.titleContent = new GUIContent("Simple Binding Property Tracking");
}
public void CreateGUI()
{
m_ObjectNameBinding = new TextField("Object Name Binding");
rootVisualElement.Add(m_ObjectNameBinding);
OnSelectionChange();
}
public void OnSelectionChange()
{
GameObject selectedObject = Selection.activeObject as GameObject;
if (selectedObject != null)
{
// Create the SerializedObject from the current selection
SerializedObject so = new SerializedObject(selectedObject);
// Note: the "name" property of a GameObject is actually named "m_Name" in serialization.
SerializedProperty property = so.FindProperty("m_Name");
// Ensure to use Unbind() before tracking a new property
m_ObjectNameBinding.Unbind();
m_ObjectNameBinding.TrackPropertyValue(property, CheckName);
// Bind the property to the field directly
m_ObjectNameBinding.BindProperty(property);
CheckName(property);
}
else
{
// Unbind any binding from the field
m_ObjectNameBinding.Unbind();
}
}
void CheckName(SerializedProperty property)
{
if (property.stringValue == "GameObject")
{
m_ObjectNameBinding.style.backgroundColor = Color.red * 0.5f;
}
else
{
m_ObjectNameBinding.style.backgroundColor = StyleKeyword.Null;
}
}
}
}
GameObject
, the background color of the label changes to dark red.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.