UXML element MaskField

The MaskField is an Editor-only control that lets users select one or more options from a list of options.

Note: To align an element with other fields in an 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 window, simply apply the .unity-base-field__aligned USS class to it. For more information, refer to BaseField.

Create a MaskField

You can create a MaskField with UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary Builder, UXML, or C#. The following C# example creates a MaskField with a default selection:

using UnityEditor.UIElements;
...
var maskField = new MaskField(); 
maskField.choices = new List<string> { "1", "2", "3" };
maskField.value = 2;
maskField.label = "Mask";

Example

The following UXML example creates a MaskField:

<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
    <uie:MaskField label="UXML Field" name="the-uxml-field" />
</UXML>

The following C# example illustrates some of the customizable functionalities of the MaskField:

/// <sample>
var choices = new List<string> { "First", "Second", "Third" };

// Get a reference to the field from UXML and assign a value to it.
var uxmlField = container.Q<MaskField>("the-uxml-field");
uxmlField.value = 1;
uxmlField.choices = choices;

// Create a new field, disable it, and give it a style class.
var csharpField = new MaskField("C# Field", choices, 0);
csharpField.SetEnabled(false);
csharpField.AddToClassList("some-styled-field");
csharpField.value = uxmlField.value;
container.Add(csharpField);

// Mirror the value of the UXML field into the C# field.
uxmlField.RegisterCallback<ChangeEvent<int>>((evt) =>
{
    csharpField.value = evt.newValue;
});
/// </sample>

To try this example live in Unity, go to Window > UI Toolkit > Samples.

C# base class and namespace

C# class: MaskField
Namespace: UnityEditor.UIElements
Base class: BaseMaskField_1

Inherited UXML attributes

This element inherits the following attributes from its base class:

This element also inherits the following attributes from VisualElement:

USS classes

The following table lists all the C# public property names and their related USS selector.

You can also use the Matching Selectors section in the Inspector or the UI Toolkit Debugger to see which USS selectors affect the components of the VisualElement at every level of its hierarchy.

Additional resources

• UXML element TagField