バージョン: 2021.3 以降
この例は UXML の BindableElement の binding-path
属性を使用して、フィールドをSerializedObject のネスト上のプロパティにバインドする方法を紹介します。
この例では、以下のようなカスタム Inspector UI を作成します。
この例で作成するすべてのファイルは、GitHub リポジトリ にあります。
このガイドは、Unity エディター、UI Toolkit、および C# スクリプトに精通している開発者を対象としています。始める前に、以下をよく理解してください。
C# スクリプトを作成し、health (ヘルス) 値を持つ戦車のクラスを定義し、戦車を破壊可能にします。
Unity で任意のテンプレートでプロジェクトを作成します。
Project ウィンドウに bind-nested-properties
という名前のフォルダーを作成し、すべてのファイルを保存します。
DestructibleTankScript.cs
という名の C# スクリプトを作成し、そのコンテンツを以下のものに置き換えます。
using System;
using UnityEngine;
using UnityEngine.Serialization;
[Serializable]
public struct Health
{
public int armor;
public int life;
}
[ExecuteInEditMode]
public class DestructibleTankScript : MonoBehaviour
{
public string tankName = "Tank";
public float tankSize = 1;
public Health health;
private void Update()
{
gameObject.name = tankName;
gameObject.transform.localScale = new Vector3(tankSize, tankSize, tankSize);
}
public void Reset()
{
health.armor = 100;
health.life = 10;
}
}
BindableElement を含む UXML ファイルを作成します。BindableElement の binding-path
を health
プロパティに設定し、BindableElement の各子要素の binding-path
を health
の armor
プロパティと life
プロパティに設定してください。
bind-nested-properties フォルダーに、Editor
という名前のフォルダーを作成します。
Editor フォルダー内に tank_inspector_styles.uss
という名前の USS ファイルを作成し、そのコンテンツを以下のように置き換えます。
.container {
background-color: rgb(80, 80, 80);
flex-direction: column;
}
Label {
background-color: rgb(80, 80, 80);
}
TextField:hover {
background-color: rgb(255, 255, 0);
}
FloatField {
background-color: rgb(0, 0, 255);
}
destructible_tank_editor.uxml
という名の UI ドキュメントを作成し、そのコンテンツを以下に置き換えます。
<UXML xmlns="UnityEngine.UIElements" xmlns:ue="UnityEditor.UIElements">
<Style src="tank_inspector_styles.uss"/>
<VisualElement name="row" class="container">
<Label text="Tank Script - Custom Inspector" />
<ue:PropertyField binding-path="tankName" name="tank-name-field" />
<ue:PropertyField binding-path="tankSize" name="tank-size-field" />
<BindableElement binding-path="health">
<ue:PropertyField binding-path="armor"/>
<ue:PropertyField binding-path="life"/>
</BindableElement>
</VisualElement>
</UXML>
DestructibleTankScript
のカスタムエディターを登録する C# スクリプトを作成します。
DestructibleTankEditor.cs
という名の C# スクリプトを作成し、そのコンテンツを以下のものに置き換えます。
using UnityEditor;
using UnityEngine;
using UnityEngine.UIElements;
[CustomEditor(typeof(DestructibleTankScript))]
public class DestructibleTankEditor : Editor
{
[SerializeField]
VisualTreeAsset visualTreeAsset;
public override VisualElement CreateInspectorGUI()
{
return visualTreeAsset.CloneTree();
}
}
Project ウィンドウで DestructibleTankEditor.cs
を選択します。
Inspector で destructible_tank_editor.uxml
を ビジュアルツリーアセット にドラッグします。
health.armor
と health.life
プロパティにバインドされます。Inspector でその値を変更すると、元となるプロパティの値も変更されます。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.