TagField 是一个仅限编辑器控件,允许用户从标签列表中选择一个标签。它通常用于检视面板Unity 窗口,显示有关当前选定游戏对象、资源或项目设置的信息,允许您检查和编辑值。更多信息
参见词汇表窗口,以允许用户为游戏对象Unity 场景中的基本对象,可以表示角色、道具、场景、摄像机、路径点等。游戏对象的功能由附加在其上的组件定义。更多信息
参见词汇表选择标签。
注意:要将元素与检视面板中的其他字段对齐,只需将.unity-base-field__aligned
USS 类应用于它。有关更多信息,请参阅BaseField
。
您可以使用UI(用户界面) 允许用户与您的应用程序交互。Unity 目前支持三种 UI 系统。更多信息
参见词汇表构建器、UXML 或 C# 创建 TagField。以下 C# 示例创建了一个带有默认标签的 TagField
using UnityEditor.UIElements;
...
var tagField = new TagField();
tagField.label = "Tag";
tagField.value = "Player";
以下 UXML 示例创建了一个 TagField
<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
<uie:TagField label="UXML Field" name="the-uxml-field" />
</UXML>
以下 C# 示例说明了 TagField 的一些可自定义功能
/// <sample>
// Get a reference to the field from UXML and assign a value to it.
var uxmlField = container.Q<TagField>("the-uxml-field");
uxmlField.value = "Player";
// Create a new field, disable it, and give it a style class.
var csharpField = new TagField("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<string>>((evt) =>
{
csharpField.value = evt.newValue;
});
/// </sample>
要在 Unity 中实时尝试此示例,请转到窗口 > UI 工具包 > 示例。
C# 类:TagField
命名空间:UnityEditor.UIElements
基类:PopupField_1
此元素从其基类继承以下属性
名称 | 类型 | 描述 |
---|---|---|
binding-path |
字符串 |
要绑定的目标属性的路径。 |
focusable |
布尔值 |
如果元素可以聚焦,则为真。 |
label |
字符串 |
表示将出现在字段旁边的标签的字符串。 |
tabindex |
整数 |
用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。 |
value |
字符串 |
弹出菜单中当前选定的值。 |
此元素还从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 |
确定此元素是否可以在 mouseEvents 或IPanel.Pick 查询期间被拾取。 |
style |
字符串 |
设置VisualElement 样式值。 |
tooltip |
字符串 |
在用户将鼠标悬停在元素上一段时间后,在信息框内显示的文本。这仅在编辑器 UI 中受支持。 |
usage-hints |
UIElements.UsageHints |
指定VisualElement 的高级预期使用模式的提示值的组合。仅当VisualElement 尚未成为Panel 的一部分时,才能设置此属性。一旦成为Panel 的一部分,此属性实际上就变为只读,尝试更改它将引发异常。正确UsageHints 的规范驱动系统根据预期的使用模式做出关于如何处理或加速某些操作的更好决策。请注意,这些提示不会影响行为或视觉结果,而只会影响面板及其内部元素的整体性能。建议始终考虑指定正确的UsageHints ,但请记住,某些UsageHints 在某些条件下可能会被内部忽略(例如,由于目标平台上的硬件限制)。 |
view-data-key |
字符串 |
用于视图数据持久性,例如树展开状态、滚动位置或缩放级别。 此键用于从视图数据存储中保存和加载视图数据。如果您不设置此键,则关联的 VisualElement 将禁用持久性。有关更多信息,请参阅视图数据持久性。 |
下表列出了所有 C# 公共属性名称及其相关的 USS 选择器。
C# 属性 | USS 选择器 | 描述 |
---|---|---|
ussClassName |
.unity-tag-field |
此类型元素的 USS 类名。 |
labelUssClassName |
.unity-tag-field__label |
此类型元素中标签的 USS 类名。 |
inputUssClassName |
.unity-tag-field__input |
此类型元素中输入元素的 USS 类名。 |
ussClassName |
.unity-popup-field |
此类型元素的 USS 类名。 |
labelUssClassName |
.unity-popup-field__label |
此类型元素中标签的 USS 类名。 |
inputUssClassName |
.unity-popup-field__input |
此类型元素中输入元素的 USS 类名。 |
ussClassName |
.unity-base-popup-field |
此类型元素的 USS 类名。 |
textUssClassName |
.unity-base-popup-field__text |
此类型元素中文本元素的 USS 类名。 |
arrowUssClassName |
.unity-base-popup-field__arrow |
此类型元素中箭头指示器的 USS 类名。 |
labelUssClassName |
.unity-base-popup-field__label |
此类型元素中标签的 USS 类名。 |
inputUssClassName |
.unity-base-popup-field__input |
此类型元素中输入元素的 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
的组件。