UXML element EnumFlagsField

An EnumFlagsField lets users select multiple values from an enumeration that are marked with the Flags attribute.

Note: To align an EnumFlagsField 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 an EnumFlagsField

You can create an EnumField with UXML and C#.

Assume you have the following enumeration:

[Flags]
enum MyEnum
{
    None = 0,
    First = 1,
    Second = 2,
    Third = 4
}

The following C# example creates an EnumFlagsField with the MyEnum enumeration and selects the first and second values:

var myEnumFlagsField = new EnumFlagsField("Select Options", MyEnum.First | MyEnum.Second);

Example

The following UXML example creates an EnumFlagsField element:

<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
    <uie:EnumFlagsField label="UXML Field" name="the-uxml-field" include-obsolete-values="false"/>
</UXML>

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

/// <sample>
// Get a reference to the field from UXML,
// initialize it with an Enum type,
// and assign a value to it.
var uxmlField = container.Q<EnumFlagsField>("the-uxml-field");
uxmlField.Init(EnumFlags.First);
uxmlField.value = EnumFlags.Second;

// Create a new field, disable it, and give it a style class.
var csharpField = new EnumFlagsField("C# Field", uxmlField.value);
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<Enum>>((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: EnumFlagsField
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 EnumField