バージョン: 2021.3 以降
この例では、UXML テンプレートを使ってバインディングパスを設定する方法を紹介します。
この例では、アセットメニューアイテムを作成します。このメニューでは、 3 つのテンプレートインスタンスを使って GameSwitch
アセットを作成し、GameSwitch
オブジェクトのプロパティにバインドします。
この例で作成するすべてのファイルは、GitHub リポジトリ にあります。
このガイドは、Unity エディター、UI Toolkit、および C# スクリプトに精通している開発者を対象としています。始める前に、以下をよく理解してください。
GameSwitch
構造体と、GameSwitch
構造体のプロパティを保持するカスタムアセットを定義するスクリプトを作成します。
Unity で任意のテンプレートでプロジェクトを作成します。
Project ウィンドウに、bind-uxml-template
という名前のフォルダーを作成し、ファイルを保存します。
GameSwitch.cs
という名前の C# スクリプトを作成し、そのコンテンツを以下のように置き換えます。
using System;
[Serializable]
public struct GameSwitch
{
public string name;
public bool enabled;
}
GameSwitchesAsset.cs
という名の C# スクリプトを作成し、そのコンテンツを以下に置き換えます。
using UnityEngine;
[CreateAssetMenu(menuName = "UIToolkitExamples/GameSwitches")]
public class GameSwitchesAsset : ScriptableObject
{
public GameSwitch useLocalServer;
public GameSwitch showDebugMenu;
public GameSwitch showFPSCounter;
// Use the Reset function to provide default values
public void Reset()
{
useLocalServer = new GameSwitch() { name = "Use Local Server", enabled = false };
showDebugMenu = new GameSwitch() { name = "Show Debug Menu", enabled = false };
showFPSCounter = new GameSwitch() { name = "Show FPS Counter", enabled = true };
}
}
GameSwitch
構造体のインスタンスごとに使用できる UXML テンプレートと、そのテンプレートを使用する UXML ファイルを作成します。
game_switch.uxml
という名前のUI ドキュメントを作成し、そのコンテンツを以下のように置き換えます。
<UXML xmlns="UnityEngine.UIElements" xmlns:ue="UnityEditor.UIElements">
<Box style="flex-direction: row;">
<Toggle binding-path="enabled" />
<TextField binding-path="name" readonly="true" style="flex-grow: 1;"/>
</Box>
</UXML>
bind-uxml-template フォルダーに、Editor
という名前のフォルダーを作成します。
Editor フォルダーに、game_switches_editor.uxml
という名の UI ドキュメントを作成し、そのコンテンツを以下と置き換えます。
<UXML xmlns="UnityEngine.UIElements" xmlns:ue="UnityEditor.UIElements">
<Template name="switch" src="../game_switch.uxml"/>
<Instance template="switch" binding-path="useLocalServer" />
<Instance template="switch" binding-path="showDebugMenu" />
<Instance template="switch" binding-path="showFPSCounter" />
</UXML>
ノート: これは、カスタムエディターのメインとなる UXML ファイルです。各プロパティは、 Instance
の binding-path
属性を介して game_switch.uxml
のインスタンスにバインドされます。
GameSwitchesAsset
用のカスタムエディターを登録するスクリプトを作成します。
GameSwitchesEditor.cs
という名の C# スクリプトを作成し、そのコンテンツを以下に置き換えます。
using UnityEditor;
using UnityEngine;
using UnityEngine.UIElements;
namespace UIToolkitExamples
{
[CustomEditor(typeof(GameSwitchesAsset))]
public class GameSwitchesEditor : Editor
{
[SerializeField]
VisualTreeAsset visualTreeAsset;
public override VisualElement CreateInspectorGUI()
{
return visualTreeAsset.CloneTree();
}
}
}
Assets
フォルダーに新しいアセットを作成します。GameSwitchesAsset.useLocalServer
、GameSwitchesAsset.showDebugMenu
、GameSwitchesAsset.showFPSCounter
プロパティに紐づけられたトグルやテキストフィールドが表示されます。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.