当绑定的属性发生更改时接收回调

版本：2021.3+

此示例演示了当绑定的序列化属性发生更改时如何接收回调。

示例概述

此示例创建了一个自定义 Editor 窗口，其中包含一个绑定到场景中游戏对象名称的 TextField。如果游戏对象的名称为 GameObject，文本字段标签的背景颜色将变为深红色。

您可以在此 GitHub 代码仓库中找到示例的完整文件。

先决条件

本指南适用于熟悉 Unity 编辑器、UI 工具包和 C# 脚本的开发者。在开始之前，请熟悉以下内容：

创建绑定以接收回调

创建一个 C# 脚本，用于：

每当序列化属性的值发生更改时调用 CheckName() 方法
向 TrackPropertyValue() 扩展方法注册方法
在另一个属性上再次调用 TrackPropertyValue() 之前调用 Unbind()。

VisualElement 在任何给定时间只能跟踪一个属性。

使用任何模板在 Unity 中创建项目。
在项目 (Project) 窗口中，创建一个名为 callback-SerializedProperty-changes 的文件夹来存储文件。
在 callback-SerializedProperty-change 文件夹中，创建一个名为 Editor 的文件夹。

在 Editor 文件夹中创建一个名为 SimpleBindingPropertyTrackingExample.cs 的 C# 脚本，并将其内容替换为以下代码：

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;
            }
        }
    }
}

测试绑定

在 Unity 中，选择窗口 (Window) > UIToolkitExamples > 简单绑定属性跟踪示例 (Simple Binding Property Tracking Example)。此时将显示一个带有文本字段的自定义编辑器 (Editor) 窗口。
在场景中选择任意游戏对象。游戏对象的名称将显示在编辑器 (Editor) 窗口的文本字段中。
在文本字段中更改游戏对象的名称。如果名称为 GameObject，标签的背景颜色将变为深红色。

其他资源

绑定到 UXML 模板

当任何绑定的属性发生更改时接收回调