기술 자료

Unity Engine


User Manual

Script Reference

Unity Engine


IntegerField

UnityEngine.UIElements.IntegerField
읽는 시간 1분최근 업데이트: 한 달 전

An IntegerField lets users input a numerical integer value. 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.
참고
To align an IntegerField with other fields in an Inspector window, simply apply the
.unity-base-field__aligned
USS class to it. For more information, refer to
BaseField
.

Create an IntegerField

You can create an IntegerField with UI Builder, UXML, and C#. The following C# code creates an IntegerField:
var integerField = new IntegerField("Label text");

Set a placeholder text

You can set a placeholder text for the element. You can also hide the placeholder text on focus.
참고
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 an IntegerField:
<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements"> <IntegerField label="UXML Field" name="the-uxml-field" /></UXML>
The following USS example styles the IntegerField:
.some-styled-field { -unity-font-style: bold;}.some-styled-field .unity-base-field__input { -unity-font-style: italic;}
The following C# example illustrates some of the customizable functionalities of the IntegerField:
// Get a reference to the field from UXML and assign a value to it. var uxmlField = container.Q<IntegerField>("the-uxml-field"); uxmlField.value = 42; // Create a new field, disable it, and give it a style class. var csharpField = new IntegerField("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<int>>((evt) => { csharpField.value = evt.newValue; });
To try this example live in Unity, go to Window > UI Toolkit > Samples.

C# base class and namespace

C# class:
IntegerField
Namespace:
UnityEngine.UIElements
Base class:
TextValueField_1

Inherited UXML attributes

This element inherits the following attributes from its base class:

Name

Type

Description

auto-correction
boolean
Determines if the touch screen keyboard auto correction is turned on or off.
binding-path
string
Path of the target property to be bound.
emoji-fallback-support
boolean
Specifies the order in which the system should look for Emoji characters when rendering text. If this setting is enabled, the global Emoji Fallback list will be searched first for characters defined as Emoji in the Unicode 14.0 standard.
focusable
boolean
Whether an element can potentially receive focus.

If false, the element can't receive focus. If true, the element receives focus only when its
Focusable.canGrabFocus
property is also true.
hide-mobile-input
boolean
Hides or shows the mobile input field.
hide-placeholder-on-focus
boolean
Hides the placeholder on focus.
is-delayed
boolean
If set to true, the value property isn't updated until either the user presses Enter or the text field loses focus.
keyboard-type
TouchScreenKeyboardType
The type of mobile keyboard that will be used.
label
string
The string representing the label that will appear beside the field. If the string is empty, the label element is removed from the hierarchy. If the string is not empty, the label element is added to the hierarchy.
mask-character
System.Char
The character used for masking in a password field.
max-length
int
Maximum number of characters for the field.
password
boolean
Returns true if the field is used to edit a password.
placeholder-text
string
A short hint to help users understand what to enter in the field.
readonly
boolean
Returns true if the field is read only.
select-all-on-focus
boolean
Controls whether the element's content is selected upon receiving focus.
select-all-on-mouse-up
boolean
Controls whether the element's content is selected when you mouse up for the first time.
select-line-by-triple-click
boolean
Controls whether triple clicking selects the entire line under the mouse pointer or not.
select-word-by-double-click
boolean
Controls whether double-clicking selects the word under the mouse pointer.
support-expressions
boolean
Indicates whether the field supports expressions that can be evaluated into a value.

Expressions are mathematical or logical constructs, such as "1+1" or "5"2", which can be processed to produce a result. When this property is enabled, the field accepts additional characters required for expressions (e.g., '+', '-', '"', '/', etc.), expanding its functionality beyond the typical restrictions of a text field that might otherwise only allow digits.
tabindex
int
An integer used to sort focusable elements in the focus ring. Must be greater than or equal to zero.

Setting the
tabIndex
value to less than
0
(for example,
−1
) removes the element from the focus ring and tab navigation.
value
int
The value associated with the field.
vertical-scroller-visibility
UIElements.ScrollerVisibility
Option for controlling the visibility of the vertical scroll bar in the
TextInputBaseField_1
.
This element also inherits the following attributes from
VisualElement
:

Name

Type

Description

content-container
string
Logical container where child elements are added. If a child is added to this element, the child is added to this element's content container instead.

When iterating over the
VisualElement.Children
of an element, the element's content container hierarchy is used instead of the element itself. This can lead to unexpected results, such as elements being ignored by the navigation events if they are not directly in the content container's hierarchy. Refer to
IFocusRing
for more information.

If the content container is the same as the element itself, child elements are added directly to the element. This is true for most elements but can be overridden by more complex types.

The
ScrollView
, for example, has a content container that is different from itself. In that case, child elements added to the scroll view are added to its content container element instead. While the physical parent (
VisualElement.Hierarchy.parent
) of the child elements is the scroll view's content container element, their logical parent (
VisualElement.parent
) still refers to the scroll view itself. Since some of the scroll view's focusable children are not part of its logical hierarchy, like its
Scroller
elements, these focusable children are not considered by default when using sequential navigation. Refer to How can I change what element is focused next for an example of a workaround solution if the default navigation rules don't correspond to your needs.
data-source
Object
Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children.
data-source-path
string
Path from the data source to the value.
data-source-type
System.Type
The possible type of data source assignable to this VisualElement.

This information is only used by the UI Builder as a hint to provide some completion to the data source path field when the effective data source cannot be specified at design time.
enabled
boolean
Returns true if the
VisualElement
is enabled locally.

This flag isn't changed if the VisualElement is disabled implicitly by one of its parents. To verify this, use
enabledInHierarchy
.
language-direction
UIElements.LanguageDirection
Indicates the directionality of the element's text. The value will propagate to the element's children.
name
string
The name of this VisualElement.

Use this property to write USS selectors that target a specific element. The standard practice is to give an element a unique name.
picking-mode
UIElements.PickingMode
Determines if this element can be the target of pointer events or picked by
IPanel.Pick
queries.

Elements can not be picked if:

- They are invisible- Their
style.display
is set to
DisplayStyle.None


Elements with a picking mode of
PickingMode.Ignore
never receive the hover pseudo-state.
style
string
Sets the style values on a
VisualElement
.

The returned style data, computed from USS files or inline styles written to this object in C#, doesn't represent the fully resolved styles, such as the final height and width of a VisualElement. To access these fully resolved styles, use
resolvedStyle
.



For information about how to use this property and all the supported USS properties, refer to the Apply styles in C# scripts and USS properties reference manual pages.
tooltip
string
Text to display inside an information box after the user hovers the element for a small amount of time. This is only supported in the Editor UI.
usage-hints
UIElements.UsageHints
A combination of hint values that specify high-level intended usage patterns for the
VisualElement
. This property can only be set when the
VisualElement
is not yet part of a
Panel
. Once part of a
Panel
, this property becomes effectively read-only, and attempts to change it will throw an exception. The specification of proper
UsageHints
drives the system to make better decisions on how to process or accelerate certain operations based on the anticipated usage pattern. Note that those hints do not affect behavioral or visual results, but only affect the overall performance of the panel and the elements within. It's advised to always consider specifying the proper
UsageHints
, but keep in mind that some
UsageHints
might be internally ignored under certain conditions (e.g. due to hardware limitations on the target platform).
view-data-key
string
Used for view data persistence, such as tree expanded states, scroll position, or zoom level.

This key is used to save and load the view data from the view data store. If you don't set this key, the persistence is disabled for the associated
VisualElement
. For more information, refer to View data persistence in the Unity Manual.

USS classes

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

C# property

USS selector

Description

ussClassName
.unity-integer-field
USS class name of elements of this type.
labelUssClassName
.unity-integer-field__label
USS class name of labels in elements of this type.
inputUssClassName
.unity-integer-field__input
USS class name of input elements in elements of this type.
ussClassName
.unity-base-text-field
USS class name of elements of this type.
labelUssClassName
.unity-base-text-field__label
USS class name of labels in elements of this type.
inputUssClassName
.unity-base-text-field__input
USS class name of input elements in elements of this type.
singleLineInputUssClassName
.unity-base-text-field__input--single-line
USS class name of single line input elements in elements of this type.
multilineInputUssClassName
.unity-base-text-field__input--multiline
USS class name of multiline input elements in elements of this type.
placeholderUssClassName
.unity-base-text-field__input--placeholder
USS class name of input elements when placeholder text is shown
ussClassName
.unity-base-field
USS class name of elements of this type.
labelUssClassName
.unity-base-field__label
USS class name of labels in elements of this type.
inputUssClassName
.unity-base-field__input
USS class name of input elements in elements of this type.
noLabelVariantUssClassName
.unity-base-field--no-label
USS class name of elements of this type, when there is no label.
labelDraggerVariantUssClassName
.unity-base-field__label--with-dragger
USS class name of labels in elements of this type, when there is a dragger attached on them.
mixedValueLabelUssClassName
.unity-base-field__label--mixed-value
USS class name of elements that show mixed values
alignedFieldUssClassName
.unity-base-field__aligned
USS class name of elements that are aligned in a inspector element
disabledUssClassName
.unity-disabled
USS class name of local disabled elements.
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