Version: 6000.0+
This example demonstrates how to bind multiple properties of a data source asset to a UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary control in UI Builder.
This example creates a data source asset that contains a Vector3
property and a float
property. The float
property is a read-only property that returns the sum of the x
, y
, and z
values of the Vector3
property. The example binds the Vector3
property to a Vector3Field
and the float
property to a FloatField
. When you change the Vector3
property in the UI, FloatField
displays the sum of the x
, y
, and z
values of the Vector3
property.
This example also demonstrates how to use the To Source binding mode to update the data source when the UI changes.
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 Toolkit, and C# scripting. Before you start, get familiar with the following:
Create a data source asset that contains the properties you want to bind to.
Assets
folder of your project, create a C# script named ExampleMultiPropertiesObject.cs
with the following content:using Unity.Properties; using UnityEngine; using UnityEngine.UIElements; #if UNITY_EDITOR using UnityEditor; #endif [CreateAssetMenu] public class ExampleMultiPropertiesObject : ScriptableObject { [Header("Bind to multiple properties")] [CreateProperty] public Vector3 vector3Value; [CreateProperty] public float sumOfVector3Properties => vector3Value.x + vector3Value.y + vector3Value.z; }
Assets
folder of your project.ExampleMultiPropertiesObject.asset
.Create a UI that binds to the data source asset you created in the previous step. In this example, you create a UXML file that contains a VisualElement with a Vector3Field and a FloatField as its child elements.
Assets
folder of your project, create a UXML file named ExampleMultiPropertiesObject.uxml
.ExampleMultiPropertiesObject.uxml
file to open it in UI Builder.Bind the UI to the data source asset you created in the previous step.
In the Inspector panel of the VisualElement, from the Bindings > Data Source > Object list, select ExampleMultiPropertiesObject.
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 panel of the Vector3Field, right-click the Value property and select Add binding.
In the Add Binding window, select vector3Value from the Data Source Path list.
From the Binding Mode list, select To Source. This updates the data source when UI changes.
Select Add binding to apply your changes.
Bind the value
property of the FloatField to the sumOfVector3Properties
property of the data source asset.
ExampleMultiPropertiesObject.uxml
file looks like the following:<engine:UXML xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:engine="UnityEngine.UIElements" xmlns:editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../../UIElementsSchema/UIElements.xsd" editor-extension-mode="False"> <engine:VisualElement data-source="MulPropertyObject.asset" name="VisualElement" style="flex-grow: 1;"> <engine:Vector3Field label="Vec3 Field"> <Bindings> <engine:DataBinding property="value" data-source-path="vector3Value" binding-mode="ToSource" /> </Bindings> </engine:Vector3Field> <engine:FloatField label="Float Field" name="FloatField"> <Bindings> <engine:DataBinding property="value" data-source-path="sumOfVector3Properties" binding-mode="ToTarget" /> </Bindings> </engine:FloatField> </engine:VisualElement> </engine:UXML>
To test the binding in the UI Builder, update the value of the Vector3 property. If the binding is set up correctly, the values replicate in the data source asset.
Assets
folder of your project, select the ExampleMultiPropertiesObject.asset
file. The Vector3 Value in the Inspector window of the ExampleObject.asset
changes to the numbers you entered.Note: If you can’t enter numbers in the Vector3Field, make the field wider by dragging the right edge of the canvas.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
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.