FloatField

A FloatField lets users input a numerical float value into an application. It accepts and displays text input. You can set placeholder text to provide hints or instructions to the user on what to enter. You can also add validation functions to ensure that the entered data meets certain requirements.

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

You can create a FloatField 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 FloatField with a value change callback:

FloatField myElement = new FloatField("Label text");

// Align the float field with the other fields.
myElement.AddToClassList("unity-base-field__aligned");
myElement.value = 0.5f;

// To delay the value change callback until the user has finished editing the value, set the isDelayed property to true.
myElement.isDelayed = true;
myElement.RegisterValueChangedCallback(evt => Debug.Log("New value: " + evt.newValue));

Set a placeholder text

You can set a placeholder text for the element. You can also hide the placeholder text on focus.

Note: The placeholder text won’t display if you set a value for the element. To unset a value in UI Builder, right-click the Value field in the element’s Inspector tab and select Unset.

In C#, use the placeholder and the hidePlaceholderOnFocus properties through textEdition:

myElement.textEdition.placeholder = "Enter your value here";
myElement.textEdition.hidePlaceholderOnFocus = true;

To style the placeholder text, use the .unity-base-text-field__input--placeholder USS selector.

Customize the input text selection

Input text is selectable by default. You can customize the selection behaviors such as selectAllOnMouseUP and selectAllOnFocus.

In C#, set them through textSelection:

myElement.textSelection.selectAllOnMouseUp = false;
myElement.textSelection.selectAllOnFocus = false;

Example

The following UXML example creates a FloatField with a placeholder:

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

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

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

// Create a new field, disable it, and give it a style class.
var csharpField = new FloatField("C# Field");
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<float>>((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: FloatField
Namespace: UnityEngine.UIElements
Base class: TextValueField_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

• Label
• TextField
• IntegerField
• DoubleField
• LongField
• PropertyField