UIDocument

UnityEngine.UIElements 中的类

留下反馈

建议更改

描述

定义一个组件，用于将 VisualElements 连接到 GameObjects。这使得可以在游戏视图中渲染在 UXML 文档中定义的 UI。

属性

panelSettings	指定要将此 UIDocument 组件连接到的 PanelSettings 实例。
parentUI	如果此 UIDocument 组件所附加的 GameObject 具有父 GameObject，并且该父 GameObject 也附加了 UIDocument 组件，则此值将自动设置为父 GameObject 的 UIDocument 组件。
rootVisualElement	UI 层次结构开始处的根视觉元素。
runtimePanel	此 UIDocument 附加到的运行时面板。
sortingOrder	此 UIDocument 相对于附加到相同 PanelSettings 或具有相同 UIDocument 父级的其他 UIDocument 在层次结构中显示的顺序。
visualTreeAsset	自动加载到根视觉元素中的 VisualTreeAsset。

继承的成员

属性

enabled	启用的行为会更新，禁用的行为不会更新。
isActiveAndEnabled	报告 GameObject 及其关联的行为是否处于活动状态且已启用。
gameObject	此组件附加到的游戏对象。组件始终附加到游戏对象。
tag	此游戏对象的标签。
transform	附加到此 GameObject 的 Transform。
destroyCancellationToken	MonoBehaviour 被销毁时引发的取消令牌（只读）。
didAwake	返回一个布尔值，表示是否调用了 Awake。
didStart	返回一个布尔值，表示是否调用了 Start。
runInEditMode	允许 MonoBehaviour 的特定实例在编辑模式下运行（仅在编辑器中可用）。
useGUILayout	禁用此选项可跳过 GUI 布局阶段。
hideFlags	对象是否应隐藏、与场景一起保存或用户可修改？
name	对象的名称。

公共方法

BroadcastMessage	在此游戏对象或其任何子级中的每个 MonoBehaviour 上调用名为 methodName 的方法。
CompareTag	将 GameObject 的标签与定义的标签进行比较。
GetComponent	获取与指定组件相同的 GameObject 上类型为 T 的组件的引用。
GetComponentInChildren	获取与指定组件相同的 GameObject 或其任何子级上类型为 T 的组件的引用。
GetComponentIndex	获取组件在其父 GameObject 上的索引。
GetComponentInParent	获取与指定组件相同的 GameObject 或其任何父级上类型为 T 的组件的引用。
GetComponents	获取与指定组件相同的 GameObject 上所有类型为 T 的组件的引用。
GetComponentsInChildren	获取与指定组件相同的 GameObject 及其任何子级上所有类型为 T 的组件的引用。
GetComponentsInParent	获取与指定组件相同的 GameObject 及其任何父级上所有类型为 T 的组件的引用。
SendMessage	在此游戏对象的每个 MonoBehaviour 上调用名为 methodName 的方法。
SendMessageUpwards	在此游戏对象的每个 MonoBehaviour 以及行为的每个祖先上调用名为 methodName 的方法。
TryGetComponent	获取指定类型的组件（如果存在）。
CancelInvoke	取消此 MonoBehaviour 上的所有 Invoke 调用。
Invoke	在 time 秒后调用 methodName 方法。
InvokeRepeating	在 time 秒后调用 methodName 方法，然后每隔 repeatRate 秒重复调用一次。
IsInvoking	methodName 上是否有任何待处理的调用？
StartCoroutine	启动一个协程。
StopAllCoroutines	停止在此行为上运行的所有协程。
StopCoroutine	停止在此行为上运行的名为 methodName 的第一个协程或存储在 routine 中的协程。
GetInstanceID	获取对象的实例 ID。
ToString	返回对象的名称。

静态方法

print	将消息记录到 Unity 控制台（与 Debug.Log 相同）。
Destroy	删除 GameObject、组件或资源。
DestroyImmediate	立即销毁对象 obj。强烈建议您改用 Destroy。
DontDestroyOnLoad	加载新场景时不要销毁目标对象。
FindAnyObjectByType	检索类型为 type 的任何活动加载的对象。
FindFirstObjectByType	检索类型为 type 的第一个活动加载的对象。
FindObjectsByType	检索类型为 type 的所有加载对象的列表。
Instantiate	克隆对象 original 并返回克隆。
InstantiateAsync	捕获原始对象（必须与某个 GameObject 相关）的快照并返回 AsyncInstantiateOperation。

运算符

bool	对象是否存在？
operator !=	比较两个对象是否引用不同的对象。
operator ==	比较两个对象引用以查看它们是否引用同一对象。

消息

Awake	当启用的脚本实例正在加载时，Unity 会调用 Awake。
FixedUpdate	与帧率无关的 MonoBehaviour.FixedUpdate 消息，用于物理计算。
LateUpdate	如果行为已启用，则 LateUpdate 会在每一帧调用。
OnAnimatorIK	设置动画 IK（逆运动学）的回调。
OnAnimatorMove	修改根运动的动画运动处理回调。
OnApplicationFocus	当玩家获得或失去焦点时，发送到所有 GameObject。
OnApplicationPause	当正在播放的应用程序在失去或重新获得焦点时暂停或恢复时，发送到所有 GameObject。
OnApplicationQuit	在应用程序退出之前发送到所有 GameObject。
OnAudioFilterRead	如果实现了 OnAudioFilterRead，Unity 将在音频 DSP 链中插入自定义滤波器。
OnBecameInvisible	当渲染器不再被任何摄像机看到时，会调用 OnBecameInvisible。
OnBecameVisible	当渲染器被任何摄像机看到时，会调用 OnBecameVisible。
OnCollisionEnter	当此碰撞体/刚体开始接触另一个刚体/碰撞体时，会调用 OnCollisionEnter。
OnCollisionEnter2D	当传入的碰撞体与此对象的碰撞体接触时发送（仅限 2D 物理）。
OnCollisionExit	当此碰撞体/刚体停止接触另一个刚体/碰撞体时，会调用 OnCollisionExit。
OnCollisionExit2D	当另一个对象的碰撞体停止接触此对象的碰撞体时发送（仅限 2D 物理）。
OnCollisionStay	对于每个与另一个碰撞体或刚体接触的碰撞体或刚体，每帧调用一次 OnCollisionStay。
OnCollisionStay2D	在另一个对象的碰撞体与此对象的碰撞体接触的每一帧发送（仅限 2D 物理）。
OnConnectedToServer	当客户端成功连接到服务器时调用。
OnControllerColliderHit	在控制器在执行 Move 时撞击碰撞体时调用 OnControllerColliderHit。
OnDestroy	销毁附加的行为将导致游戏或场景接收 OnDestroy。
OnDisable	当行为变为禁用时，会调用此函数。
OnDrawGizmos	如果要绘制也可选取且始终绘制的 gizmos，请实现 OnDrawGizmos。
OnDrawGizmosSelected	如果选中了对象，请实现 OnDrawGizmosSelected 以绘制 gizmo。
OnEnable	当对象变为启用且活动时，会调用此函数。
OnFailedToConnect	当连接尝试由于某种原因失败时，在客户端调用。
OnGUI	OnGUI 用于渲染和处理 GUI 事件。
OnJointBreak	当附加到相同游戏对象的关节断裂时调用。
OnJointBreak2D	当附加到相同游戏对象的 Joint2D 断裂时调用。
OnMouseDown	当用户在碰撞体上按下鼠标左键时，会调用 OnMouseDown。
OnMouseDrag	当用户单击碰撞体并仍按住鼠标时，会调用 OnMouseDrag。
OnMouseEnter	当鼠标进入碰撞体时调用。
OnMouseExit	当鼠标不再位于碰撞体上时调用。
OnMouseOver	当鼠标位于碰撞体上时，每帧调用一次。
OnMouseUp	当用户释放鼠标按钮时，会调用 OnMouseUp。
OnMouseUpAsButton	仅当鼠标在与按下时相同的碰撞体上释放时，才会调用 OnMouseUpAsButton。
OnParticleCollision	当粒子撞击碰撞体时，会调用 OnParticleCollision。
OnParticleSystemStopped	当系统中的所有粒子都死亡且不会产生新的粒子时，会调用 OnParticleSystemStopped。在调用 Stop 或非循环系统的持续时间属性超过时，新的粒子将停止创建。
OnParticleTrigger	当粒子系统中的任何粒子满足触发模块中的条件时，会调用 OnParticleTrigger。
OnParticleUpdateJobScheduled	当粒子系统的内置更新作业已安排时，会调用 OnParticleUpdateJobScheduled。
OnPostRender	摄像机渲染场景后，Unity 调用的事件函数。
OnPreCull	摄像机剔除场景之前，Unity 调用的事件函数。
OnPreRender	摄像机渲染场景之前，Unity 调用的事件函数。
OnRenderImage	摄像机完成渲染后，Unity 调用的事件函数，允许您修改摄像机的最终图像。
OnRenderObject	摄像机渲染完场景后调用 OnRenderObject。
OnServerInitialized	每当调用 Network.InitializeServer 并已完成时，在服务器上调用。
OnTransformChildrenChanged	当 GameObject 的 Transform 的子级列表发生更改时，会调用此函数。
OnTransformParentChanged	当 GameObject 的 Transform 的直接或间接父级发生更改时，会调用此函数。
OnTriggerEnter	当一个 GameObject 与另一个 GameObject 碰撞时，Unity 会调用 OnTriggerEnter。
OnTriggerEnter2D	当另一个对象进入附加到此对象的触发器碰撞体时发送（仅限 2D 物理）。
OnTriggerExit	当 Collider other 停止接触触发器时，会调用 OnTriggerExit。
OnTriggerExit2D	当另一个对象离开附加到此对象的触发器碰撞体时发送（仅限 2D 物理）。
OnTriggerStay	对于每个与触发器接触的 Collider other，每进行一次物理更新调用一次 OnTriggerStay。
OnTriggerStay2D	当另一个对象位于附加到此对象的触发器碰撞体中时，每进行一次物理更新发送一次（仅限 2D 物理）。
OnValidate	当加载脚本或 Inspector 中的值发生更改时，Unity 调用的仅编辑器函数。
OnWillRenderObject	如果对象可见且不是 UI 元素，则对每个摄像机调用 OnWillRenderObject。
重置	重置为默认值。
开始	当脚本启用时，在第一次调用任何 Update 方法之前，在该帧上调用 Start。
更新	如果 MonoBehaviour 已启用，则每帧调用 Update。

此处描述的内容是否未按预期工作？这可能是已知问题。请在以下网址的 Issue Tracker 中查看 issuetracker.unity3d.com.

脚本 API

UIDocument

成功！

提交失败

描述

属性

继承的成员

属性

公共方法

静态方法

运算符

消息