版本:Unity 6 (6000.0)
语言:英语
UXML 元素 EnumFlagsField
UXML 元素 Foldout

UXML 元素 FloatField

FloatField 允许用户将数值浮点型值输入到应用程序中。它接受并显示文本输入。您可以设置占位符文本以向用户提供有关输入内容的提示或说明。您还可以添加验证函数以确保输入的数据满足特定要求。

注意:要使 FloatField 与 检视器一个 Unity 窗口,用于显示有关当前选定游戏对象、资源或项目设置的信息,允许您检查和编辑值。 更多信息
参见 术语表
窗口中的其他字段对齐,只需将 .unity-base-field__aligned USS 类应用于它即可。有关更多信息,请参阅 BaseField

创建 FloatField

您可以使用 UI(用户界面) 允许用户与您的应用程序交互。Unity 目前支持三种 UI 系统。 更多信息
参见 术语表
构建器、UXML 和 C# 创建 FloatField。以下 C# 示例创建具有值更改回调的 FloatField

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));

设置占位符文本

您可以为元素设置占位符文本。您还可以隐藏聚焦时的占位符文本。

注意:如果您为元素设置了值,占位符文本将不会显示。要取消设置 UI 构建器中的值,请右键单击元素的检视器选项卡中的字段,然后选择取消设置

在 C# 中,使用 placeholderhidePlaceholderOnFocus 属性,通过 textEdition

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

要设置占位符文本的样式,请使用 .unity-base-text-field__input--placeholder USS 选择器。

自定义输入文本选择

输入文本默认情况下是可选择的。您可以自定义选择行为,例如 selectAllOnMouseUPselectAllOnFocus

在 C# 中,通过 textSelection 设置它们

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

示例

以下 UXML 示例创建带有占位符的 FloatField

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

以下 C# 示例说明了 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>

要尝试在 Unity 中实时使用此示例,请转到窗口 > UI 工具包 > 示例

C# 基类和命名空间

C# 类FloatField
命名空间UnityEngine.UIElements
基类TextValueField_1

继承的 UXML 属性

此元素从其基类继承以下属性

名称 类型 描述
auto-correction 布尔值 确定触控屏键盘自动更正是否打开或关闭。
binding-path 字符串 要绑定的目标属性的路径。
emoji-fallback-support 布尔值 指定系统在渲染文本时查找 Emoji 字符的顺序。如果此设置已启用,则系统将首先在全局 Emoji 备用列表中搜索在 Unicode 14.0 标准中定义为 Emoji 的字符。
focusable 布尔值 如果元素可以聚焦,则为 True。
hide-mobile-input 布尔值 隐藏或显示移动输入字段。
is-delayed 布尔值 如果设置为 true,则在用户按下 Enter 或文本字段失去焦点之前,不会更新 value 属性。
keyboard-type TouchScreenKeyboardType 将使用的移动键盘类型。
label 字符串 表示将显示在字段旁边的标签的字符串。
max-length int 字段的最大字符数。
select-all-on-focus 布尔值 控制元素在获得焦点时是否选择其内容。
select-all-on-mouse-up 布尔值 控制您第一次鼠标向上时是否选择元素的内容。
tabindex int 用于在焦点环中对可聚焦项进行排序的整数。必须大于或等于零。
value float 与字段关联的值。
vertical-scroller-visibility UIElements.ScrollerVisibility 用于控制 TextInputBaseField_1 中垂直滚动条可见性的选项。

此元素还从 VisualElement 继承以下属性

名称 类型 描述
content-container 字符串 子元素被添加到其中,通常与元素本身相同。
data-source 对象 将数据源分配给此 VisualElement,它将覆盖任何继承的数据源。此数据源由所有子项继承。
data-source-path 字符串 从数据源到值的路径。
data-source-type System.Type 可以分配给此 VisualElement 的数据源的可能类型。

此信息仅由 UI 构建器使用,作为提示,以便在设计时无法指定有效数据源时,为数据源路径字段提供一些完成。
language-direction UIElements.LanguageDirection 指示元素文本的方向。该值将传播到元素的子项。

将 languageDirection 设置为 RTL 会通过反转文本并适当地处理断行和换行来添加对从右到左 (RTL) 的基本支持。但是,它不提供全面的 RTL 支持,因为这将需要文本整形,包括字符的重新排序,以及 OpenType 字体功能支持。全面的 RTL 支持计划在未来的更新中提供,这将涉及处理语言、脚本和字体功能规范的其他 API。

为了增强此属性的 RTL 功能,用户可以探索 Unity Asset Store 中可用的第三方插件并使用 ITextElementExperimentalFeatures.renderedText
name 字符串 此 VisualElement 的名称。

使用此属性编写以特定元素为目标的 USS 选择器。标准做法是为元素提供一个唯一的名称。
picking-mode UIElements.PickingMode 确定此元素是否可以在鼠标事件或 IPanel.Pick 查询期间被拾取。
style 字符串 设置 VisualElement 样式值。
tooltip 字符串 在用户将鼠标悬停在元素上一段时间后,在信息框中显示的文本。这仅在编辑器 UI 中受支持。
usage-hints UIElements.UsageHints 指定 VisualElement 高级预期使用模式的提示值组合。此属性只能在 VisualElement 尚未成为 Panel 的一部分时设置。一旦成为 Panel 的一部分,此属性将实际上变为只读,尝试更改它将引发异常。正确 UsageHints 的规范会驱动系统根据预期的使用模式更好地决定如何处理或加速某些操作。请注意,这些提示不会影响行为或视觉结果,只会影响面板及其内部元素的整体性能。建议始终考虑指定正确的 UsageHints,但请记住,在某些情况下,某些 UsageHints 可能在内部被忽略(例如,由于目标平台上的硬件限制)。
view-data-key 字符串 用于视图数据持久性,例如树展开状态、滚动位置或缩放级别。

此键用于从视图数据存储中保存和加载视图数据。如果您没有设置此键,则关联的 VisualElement 的持久性将被禁用。有关更多信息,请参阅 视图数据持久性

USS 类

下表列出了所有 C# 公共属性名称及其相关的 USS 选择器。

C# 属性 USS 选择器 描述
ussClassName .unity-float-field 此类型元素的 USS 类名。
labelUssClassName .unity-float-field__label 此类型元素中标签的 USS 类名。
inputUssClassName .unity-float-field__input 此类型元素中输入元素的 USS 类名。
ussClassName .unity-base-text-field 此类型元素的 USS 类名。
labelUssClassName .unity-base-text-field__label 此类型元素中标签的 USS 类名。
inputUssClassName .unity-base-text-field__input 此类型元素中输入元素的 USS 类名。
singleLineInputUssClassName .unity-base-text-field__input--single-line 此类型元素中单行输入元素的 USS 类名。
multilineInputUssClassName .unity-base-text-field__input--multiline 此类型元素中多行输入元素的 USS 类名。
placeholderUssClassName .unity-base-text-field__input--placeholder 显示占位符文本时输入元素的 USS 类名
ussClassName .unity-base-field 此类型元素的 USS 类名。
labelUssClassName .unity-base-field__label 此类型元素中标签的 USS 类名。
inputUssClassName .unity-base-field__input 此类型元素中输入元素的 USS 类名。
noLabelVariantUssClassName .unity-base-field--no-label 此类型元素的 USS 类名,当没有标签时。
labelDraggerVariantUssClassName .unity-base-field__label--with-dragger 此类型元素中标签的 USS 类名,当在其上附加拖动器时。
mixedValueLabelUssClassName .unity-base-field__label--mixed-value 显示混合值的元素的 USS 类名
alignedFieldUssClassName .unity-base-field__aligned 在检视器元素中对齐的元素的 USS 类名
disabledUssClassName .unity-disabled 本地禁用元素的 USS 类名。

您还可以使用 检视器或 UI 工具包调试器中的匹配选择器部分 来查看哪些 USS 选择器影响 VisualElement 层次结构中每一级的组件。

其他资源

UXML 元素 EnumFlagsField
UXML 元素 Foldout