UXML element LayerField

A LayerField allows the users to select a layer from a list of available layersLayers in Unity can be used to selectively opt groups of GameObjects in or out of certain processes or calculations. This includes camera rendering, lighting, physics collisions, or custom calculations in your own code. More info
See in Glossary.

Note: To align a LayerField 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 LayerField

You can create a LayerField 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, and C#. The following C# example creates a LayerField with the default value:

LayerField myElement = new LayerField("Label text");
// Sets the default value to 2.
myElement.value = 2;

Example

The following UXML example creates a LayerField:

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

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

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

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

// Mirror value of 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: LayerField
Namespace: UnityEditor.UIElements
Base class: PopupField_1

Inherited 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 LayerMaskField
• Layers