Text

class in UnityEngine.UI

实现接口：ICanvasElement, IClippable, ILayoutElement, IMaskable, IMaterialModifier

描述

用于向屏幕绘制字体数据的默认 Graphic。

变量

alignByGeometry	使用字形几何形状的范围（而不是字形指标）执行水平对齐。
alignment	文本相对其 RectTransform 的定位。
cachedTextGenerator	生成可见 Text 时使用的已缓存的 TextGenerator。
cachedTextGeneratorForLayout	确定 Layout 时使用的已缓存的 TextGenerator。
flexibleHeight	由布局系统调用。
flexibleWidth	由布局系统调用。
font	文本使用的 Font。
fontSize	Font 渲染时应使用的大小。
fontStyle	文本使用的 FontStyle。
horizontalOverflow	水平溢出模式。
layoutPriority	由布局系统调用。
lineSpacing	行间距，指定为字体行高的一个因子。值为 1 时将生成标准行间距。
mainTexture	来自 Font 的 Texture。
minHeight	由布局系统调用。
minWidth	由布局系统调用。
pixelsPerUnit	（只读）提供有关如何根据屏幕缩放字体的信息。
preferredHeight	由布局系统调用。
preferredWidth	由布局系统调用。
resizeTextForBestFit	是否允许文本自动调整大小。
resizeTextMaxSize	允许的最大文本大小。1 = 无限大。
resizeTextMinSize	允许的最小文本大小。
supportRichText	此 Text 是否支持富文本。
text	此 Text 显示的字符串值。
verticalOverflow	垂直溢出模式。

公共函数

CalculateLayoutInputHorizontal	由布局系统调用。
CalculateLayoutInputVertical	由布局系统调用。
FontTextureChanged	在修改与字体关联的纹理时由 [FontUpdateTracker] 调用。
GetGenerationSettings	便捷函数，用于填充文本的生成设置。

受保护的函数

OnDisable

请参阅 MonoBehaviour.OnDisable。

静态函数

GetTextAnchorPivot

便捷函数，用于确定锚点的向量偏移。

继承的成员

静态变量

defaultGraphicMaterial

在未显式指定材质时用于绘制 UI 元素的默认材质。

变量

enabled	启用的 Behaviour 可更新，禁用的 Behaviour 不可更新。
isActiveAndEnabled	已调用启用的 Behaviour。
gameObject	此组件附加到的游戏对象。始终将组件附加到游戏对象。
tag	此游戏对象的标签。
transform	附加到此 GameObject 的 Transform。
canvas	对在其中渲染此 Graphic 的 Canvas 的引用。
canvasRenderer	此 Graphic 使用的 CanvasRenderer。
color	此 Graphic 的基色。
defaultMaterial	返回图形的默认材质。
depth	图形在层级视图中的绝对深度（由渲染和事件使用）。
mainTexture	图形的纹理。（只读）。
material	用户设置的 Material。
materialForRendering	为进行渲染而发送的材质（只读）。
raycastTarget	是否应将此图形视为射线投射目标？
rectTransform	此 Graphic 使用的 RectTransform 组件。
maskable	此图形是否允许遮罩。
onCullStateChanged	在剔除更改时发出的回调。
runInEditMode	允许 MonoBehaviour 的特定实例在编辑模式下运行（仅可在 Editor 中使用）。
useGUILayout	禁用该属性可跳过 GUI 布局阶段。
hideFlags	该对象应该隐藏、随场景一起保存还是由用户修改？
name	对象的名称。

公共函数

BroadcastMessage	调用此游戏对象或其任何子项中的每个 MonoBehaviour 上名为 methodName 的方法。
CompareTag	此游戏对象是否使用 tag 进行了标记？
GetComponent	如果游戏对象附加了类型为 type 的组件，则将其返回，否则返回 null。
GetComponentInChildren	使用深度首次搜索返回 GameObject 或其任何子项中类型为 type 的组件。
GetComponentInParent	返回 GameObject 或其任何父项中类型为 type 的组件。
GetComponents	返回 GameObject 中类型为 type 的所有组件。
GetComponentsInChildren	返回 GameObject 或其任何子项中类型为 type 的所有组件。
GetComponentsInParent	返回 GameObject 或其任何父项中类型为 type 的所有组件。
SendMessage	调用此游戏对象中的每个 MonoBehaviour 上名为 methodName 的方法。
SendMessageUpwards	调用此游戏对象中的每个 MonoBehaviour 上或此行为的每个父级上名为 methodName 的方法。
CrossFadeAlpha	对与此图形关联的 CanvasRenderer 颜色的 Alpha 执行 Tween 操作。
CrossFadeColor	对与此 Graphic 关联的 CanvasRenderer 颜色执行 Tween 操作。
GetPixelAdjustedRect	返回最接近 Graphic RectTransform 的像素精准矩形。
GraphicUpdateComplete	请参阅 ICanvasElement.GraphicUpdateComplete。
LayoutComplete	请参阅 ICanvasElement.LayoutComplete。
OnRebuildRequested	在需要重新构建 Graphic 时由 Unity 发出的仅限于编辑器的回调。
PixelAdjustPoint	调整给定像素以使像素精准。
Raycast	当 GraphicRaycaster 射线投射到场景中时，它会执行两个操作。首先它使用 RectTransform 矩形过滤元素。然后它使用此 Raycast 函数确定射线投射命中的元素。
Rebuild	按 PreRender 周期重新构建图形几何形状及其材质。
RegisterDirtyLayoutCallback	添加监听器，以在图形布局脏化时接收通知。
RegisterDirtyMaterialCallback	添加监听器，以在图形材质脏化时接收通知。
RegisterDirtyVerticesCallback	添加监听器，以在图形顶点脏化时接收通知。
SetAllDirty	将 Graphic 标记为“脏”。
SetLayoutDirty	将布局标记为“脏”。
SetMaterialDirty	将 Material 标记为“脏”。
SetNativeSize	调整图形大小以使其像素精准。
SetVerticesDirty	将顶点标记为“脏”。
UnregisterDirtyLayoutCallback	删除监听器，在图形布局脏化时不接收通知。
UnregisterDirtyMaterialCallback	删除监听器，在图形材质脏化时不接收通知。
UnregisterDirtyVerticesCallback	删除监听器，在图形顶点脏化时不接收通知。
Cull	请参阅 IClippable.Cull。
GetModifiedMaterial	请参阅 IMaterialModifier.GetModifiedMaterial。
RecalculateClipping	请参阅：IClippable.RecalculateClipping。
RecalculateMasking	请参阅：IMaskable.RecalculateMasking。
SetClipRect	请参阅 IClippable.SetClipRect。
CancelInvoke	取消该 MonoBehaviour 上的所有 Invoke 调用。
Invoke	在 time 秒后调用 methodName 方法。
InvokeRepeating	在 time 秒后调用 methodName 方法，然后每 repeatRate 秒调用一次。
IsInvoking	是否有任何待处理的 methodName 调用？
StartCoroutine	启动一个协同程序。
StopAllCoroutines	停止在该行为上运行的所有协同程序。
StopCoroutine	停止在该行为上运行的第一个名为 methodName 的协同程序或存储在 routine 中的协同程序。
GetInstanceID	返回对象的实例 ID。
ToString	返回 GameObject 的名称。
IsActive	如果 GameObject 和 Component 处于激活状态，则返回 true。
IsDestroyed	如果行为的原生表示已被销毁，则返回 true。

受保护的函数

OnPopulateMesh	UI 元素需要生成顶点时的回调函数。
UpdateGeometry	用于将 Graphic 的几何形状更新到 CanvasRenderer 的调用。
UpdateMaterial	用于将 Graphic 的 Material 更新到 CanvasRenderer 的调用。
Awake	请参阅 MonoBehaviour.Awake。
OnBeforeTransformParentChanged	请参阅 MonoBehaviour.OnBeforeTransformParentChanged。
OnCanvasGroupChanged	请参阅 MonoBehaviour.OnCanvasGroupChanged。
OnCanvasHierarchyChanged	在父画布的状态发生更改时调用。
OnDestroy	请参阅 MonoBehaviour.OnDestroy。
OnDidApplyAnimationProperties	请参阅 LayoutGroup.OnDidApplyAnimationProperties。
OnEnable	请参阅 MonoBehaviour.OnEnable。
OnRectTransformDimensionsChange	This callback is called if an associated RectTransform has its dimensions changed. The call is also made to all child rect transforms, even if the child transform itself doesn't change - as it could have, depending on its anchoring.
OnTransformParentChanged	请参阅 MonoBehaviour.OnRectTransformParentChanged。
OnValidate	请参阅 MonoBehaviour.OnValidate。
Reset	请参阅 MonoBehaviour.Reset。
Start	请参阅 MonoBehaviour.Start。

静态函数

print	将消息记录到 Unity 控制台（与 Debug.Log 相同）。
Destroy	删除 GameObject、组件或资源。
DestroyImmediate	立即销毁对象 /obj/。强烈建议您改用 Destroy。
DontDestroyOnLoad	加载新场景时，不自动销毁对象 /target/。
FindObjectOfType	返回第一个类型为 type 的已加载的激活对象。
FindObjectsOfType	返回所有类型为 type 的已加载的激活对象的列表。
Instantiate	克隆 original 对象并返回克隆对象。

运算符

bool	该对象是否存在？
operator !=	比较两个对象是否引用不同的对象。
operator ==	比较两个对象引用，判断它们是否引用同一个对象。

消息

Awake	Awake 在加载脚本实例时调用。
FixedUpdate	如果启用了 MonoBehaviour，则每个固定帧率帧调用该函数。
LateUpdate	如果启用了 Behaviour，则每帧调用 LateUpdate。
OnAnimatorIK	用于设置动画 IK（反向运动学）的回调。
OnAnimatorMove	用于处理动画移动以修改根运动的回调。
OnApplicationFocus	当玩家获得或失去焦点时，发送给所有 GameObject。
OnApplicationPause	当应用程序暂停时，发送给所有 GameObject。
OnApplicationQuit	Sent to all game objects before the application is quit.
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	This function is called when the MonoBehaviour will be destroyed.
OnDisconnectedFromServer	当连接丢失或与服务器断开连接时，在客户端上调用。
OnDrawGizmos	如果您想绘制能够选择并且始终绘制的辅助图标，则可以实现 OnDrawGizmos。
OnDrawGizmosSelected	如果选择了对象，则实现 OnDrawGizmosSelected 来绘制辅助图标。
OnEnable	该函数在对象变为启用和激活状态时调用。
OnFailedToConnect	出于某种原因连接尝试失败时，在客户端上调用。
OnFailedToConnectToMasterServer	在连接到 MasterServer 时发生问题的情况下，在客户端或服务器上调用。
OnGUI	系统调用 OnGUI 来渲染和处理 GUI 事件。
OnJointBreak	在附加到相同游戏对象的关节断开时调用。
OnJointBreak2D	在附加到相同游戏对象的 Joint2D 断开时调用。
OnMasterServerEvent	在从 MasterServer 报告事件时，在客户端或服务器上调用。
OnMouseDown	OnMouseDown is called when the user has pressed the mouse button while over the GUIElement or Collider.
OnMouseDrag	当用户单击 GUIElement 或 Collider 并仍然按住鼠标时，将调用 OnMouseDrag。
OnMouseEnter	当鼠标进入 GUIElement 或 Collider 时调用。
OnMouseExit	当鼠标不再处于 GUIElement 或 Collider 上方时调用。
OnMouseOver	当鼠标悬停在 GUIElement 或 Collider 上时，每帧调用一次。
OnMouseUp	当用户松开鼠标按钮时，将调用 OnMouseUp。
OnMouseUpAsButton	松开鼠标时，仅当鼠标在按下时所在的 GUIElement 或 Collider 上时，才调用 OnMouseUpAsButton。
OnNetworkInstantiate	在已通过 Network.Instantiate 进行网络实例化的对象上调用。
OnParticleCollision	当粒子击中碰撞体时，将调用 OnParticleCollision。
OnParticleTrigger	当粒子系统中的任何粒子满足触发模块中的条件时，将调用 OnParticleTrigger。
OnPlayerConnected	每当有新玩家成功连接，就在服务器上调用。
OnPlayerDisconnected	每当有玩家与服务器断开连接，就在服务器上调用。
OnPostRender	在摄像机完成场景渲染后，将调用 OnPostRender。
OnPreCull	OnPreCull 在摄像机剔除场景前调用。
OnPreRender	OnPreRender 在摄像机开始渲染场景前调用。
OnRenderImage	OnRenderImage 在图像的所有渲染操作全部完成后调用。
OnRenderObject	OnRenderObject 在摄像机渲染场景后调用。
OnSerializeNetworkView	用于在网络视图监视的脚本中自定义变量同步。
OnServerInitialized	每当调用 Network.InitializeServer 并且完成时，对该服务器调用该函数。
OnTransformChildrenChanged	当 GameObject 的变换的子项列表发生更改时，将调用该函数。
OnTransformParentChanged	当 GameObject 的变换的父属性发生更改时，将调用该函数。
OnTriggerEnter	当 Collider other 事件进入该触发器时调用 OnTriggerEnter。
OnTriggerEnter2D	当另一个对象进入附加到该对象的触发碰撞体时发送（仅限 2D 物理）。
OnTriggerExit	当 Collider other 已停止接触该触发器时调用 OnTriggerExit。
OnTriggerExit2D	当另一个对象离开附加到该对象的触发碰撞体时发送（仅限 2D 物理）。
OnTriggerStay	OnTriggerStay is called once per frame for every Collider other that is touching the trigger.
OnTriggerStay2D	在另一个对象位于附加到该对象的触发碰撞体之内时发送每个帧（仅限 2D 物理）。
OnValidate	加载脚本后或 Inspector 中的值发生更改时，将调用该函数（只能在 Editor 中调用）。
OnWillRenderObject	如果对象可见并且不是 UI 元素，则为每个摄像机调用 OnWillRenderObject。
Reset	重置为默认值。
Start	Start is called on the frame when a script is enabled just before any of the Update methods is called the first time.
Update	如果启用了 MonoBehaviour，则每帧调用 Update。

脚本 API

Text

描述

变量

公共函数

受保护的函数

静态函数

继承的成员

静态变量

变量

公共函数

受保护的函数

静态函数

运算符

消息