Version: 2019.2
语言: 中文

InputField

class in UnityEngine.UI

/

继承自：UI.Selectable


实现接口：IBeginDragHandler, ICanvasElement, IDragHandler, IEndDragHandler, IEventSystemHandler, ILayoutElement, IPointerClickHandler, ISubmitHandler, IUpdateSelectedHandler

切换到手册

描述

将简单的标签转换为可交互的输入字段。

变量

asteriskChar用于密码字段的字符。
caretBlinkRate输入光标的闪烁率，定义为每秒的闪烁周期发生次数。
caretColor设置了 customCaretColor 时使用的自定义光标颜色。
caretPosition当前 InputField 光标位置（以及选择尾部）。
caretWidth光标的宽度（以像素为单位）。
characterLimit输入字段可以输入的字符数限制为 0 = 无限。
characterValidation要对字符执行的验证的类型。
contentType指定输入文本内容的类型。
customCaretColor应该使用自定义光标颜色还是 textComponent.color。
inputType预期输入类型。请参阅 InputField.InputType。
isFocused InputField 当前是否具有焦点且能够处理事件。
keyboardType将使用的移动键盘类型。
lineType InputField 使用的 LineType。
multiLine如果输入字段支持多行。
onEndEdit编辑结束时要调用的 Unity 事件。
onValidateInput验证输入字符时调用的函数。
onValueChanged OnChangeEvent 的访问器。
placeholder这是一个可选的“空”图形，用于表明 InputField 文本字段为空。
readOnly将 InputField 设置为只读。
selectionAnchorPosition选择的起点。
selectionColor突出显示的颜色，以显示选择了哪些字符。
selectionFocusPosition选择的结束点。
shouldHideMobileInput应隐藏移动键盘输入。
text输入字段的当前值。
textComponent将用于将文本渲染到屏幕的 Text 组件。
touchScreenKeyboard用于编辑输入字段的 TouchScreenKeyboard。
wasCanceled如果 InputField 被取消，则执行 DeactivateInputField 后该字段将立即恢复为原始文本。

公共函数

ActivateInputField用于激活 InputField 以开始处理 Events 的函数。
DeactivateInputField用于停用 InputField 以停止处理 Events 的函数，并且如果未取消，则发送 OnSubmit。
ForceLabelUpdate强制使标签立即更新。这将重新计算光标和可见文本的位置。
GraphicUpdateComplete请参阅 ICanvasElement.GraphicUpdateComplete。
LayoutComplete请参阅 ICanvasElement.LayoutComplete。
MoveTextEnd将光标索引移动至文本末尾。
MoveTextStart将光标索引移动至文本开头。
OnBeginDrag从 EventSystem 捕获 OnBeginDrag 回调，并确保我们应监听要跟进的 Drag 事件。
OnDeselect在事件系统发送 Deselect 事件时要执行的操作。
OnDrag在事件系统发送 Drag 事件时要执行的操作。
OnEndDrag从 EventSystem 捕获 OnEndDrag 回调，并取消对 Drag 事件的监听。
OnPointerClick在事件系统发送 pointer click 事件时要执行的操作。
OnPointerDown在事件系统发送 pointer down 事件时要执行的操作。
OnSubmit在事件系统发送 Submit 事件时要执行的操作。
OnUpdateSelected在事件系统发送 Update selected 事件时要执行的操作。
ProcessEventHelper 函数允许 InputField 处理单独的事件。
Rebuild重新构建输入字段几何形状。（光标和突出显示。）

受保护的函数

Append向输入字段中附加字符。
ClampPos将值（通过引用）限制在 0 到当前文本长度之间。
GetCharacterIndexFromPosition鼠标下的字符。
KeyPressed处理 Event 并对该键执行适当的操作。
OnDisable请参阅 MonoBehaviour.OnDisable。
OnFocus聚焦输入字段初始化属性。
SelectAll突出显示整个 InputField。
SendOnSubmit用于使功能更轻松地发送 SubmitEvent 的便捷函数。
UpdateLabel更新与此输入字段关联的 Text。
Validate适用于不同 characterValidation 类型的预定义验证功能。

委托

OnValidateInput自定义验证回调。

继承的成员

静态变量

allSelectablesList of all the selectable objects currently active in the Scene.

变量

enabled启用的 Behaviour 可更新，禁用的 Behaviour 不可更新。
isActiveAndEnabled是否已激活并启用 Behaviour？
gameObject此组件附加到的游戏对象。始终将组件附加到游戏对象。
tag此游戏对象的标签。
transform附加到此 GameObject 的 Transform。
runInEditMode允许 MonoBehaviour 的特定实例在编辑模式下运行（仅可在 Editor 中使用）。
useGUILayout禁用该属性可跳过 GUI 布局阶段。
hideFlags该对象应该隐藏、随场景一起保存还是由用户修改？
name对象的名称。
animationTriggers用于此可选择对象的 AnimationTriggers。
animator便捷函数，用于获取 GameObject 中的 Animator 组件。
colors用于此可选择对象的 ColorBlock。
image便捷函数，可将引用的 Graphic 转换为 Image（如果可能）。
interactable用于启用或禁用对可选择 UI 元素（例如，按钮）进行选择的功能。
navigation此可选择对象的 Navigation 设置。
spriteState用于此可选择对象的 SpriteState。
targetGraphic将过渡的 Graphic。
transition过渡的类型，当状态更改时将应用于 targetGraphic。

公共函数

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 的方法。
CancelInvoke取消该 MonoBehaviour 上的所有 Invoke 调用。
Invoke在 time 秒后调用 methodName 方法。
InvokeRepeating在 time 秒后调用 methodName 方法，然后每 repeatRate 秒调用一次。
IsInvoking是否有任何待处理的 methodName 调用？
StartCoroutine启动协程。
StopAllCoroutines停止在该行为上运行的所有协同程序。
StopCoroutine停止在该行为上运行的第一个名为 methodName 的协同程序或存储在 routine 中的协同程序。
GetInstanceID返回对象的实例 ID。
ToString返回对象的名称。
FindSelectable查找此对象旁边的可选择对象。
FindSelectableOnDown查找此对象下方的可选择对象。
FindSelectableOnLeft查找此对象左侧的可选择对象。
FindSelectableOnRight查找此对象右侧的可选择对象。
FindSelectableOnUp查找此对象上方的可选择对象。
IsInteractableUI.Selectable.IsInteractable。
OnMove确定应在 4 个移动方向中的哪个方向找到下一个可选择对象。
OnPointerEnter评估当前状态并过渡至适当状态。
OnPointerExit评估当前状态并过渡至正常状态。
OnPointerUp评估 eventData 并过渡至适当状态。
OnSelect设置选择并过渡到适当状态。
Select选择此 Selectable 对象。
IsActive如果 GameObject 和 Component 处于激活状态，则返回 true。
IsDestroyed如果行为的原生表示已被销毁，则返回 true。

受保护的函数

DoStateTransition将 Selectable 过渡到已进入的状态。
InstantClearState从 Selectable 中清除任何内部状态（禁用时使用）。
IsHighlighted返回有关可选择对象当前是否“突出显示”的信息。
IsPressed当前的可选择对象是否被按下。
UpdateSelectionState在内部更新 Selectable 的选择状态。
Awake请参阅 MonoBehaviour.Awake。
OnBeforeTransformParentChanged请参阅 MonoBehaviour.OnBeforeTransformParentChanged。
OnCanvasGroupChanged请参阅 MonoBehaviour.OnCanvasGroupChanged。
OnCanvasHierarchyChanged在父画布的状态发生更改时调用。
OnDestroy请参阅 MonoBehaviour.OnDestroy。
OnDidApplyAnimationProperties请参阅 LayoutGroup.OnDidApplyAnimationProperties。
OnEnable请参阅 MonoBehaviour.OnEnable。
OnRectTransformDimensionsChange如果关联的 RectTransform 的尺寸发生更改，则系统会调用此回调。
OnTransformParentChanged请参阅 MonoBehaviour.OnRectTransformParentChanged。
OnValidate请参阅 MonoBehaviour.OnValidate。
Reset请参阅 MonoBehaviour.Reset。
Start请参阅 MonoBehaviour.Start。

静态函数

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

运算符

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

消息

AwakeAwake 在加载脚本实例时调用。
FixedUpdate用于物理计算且独立于帧率的 MonoBehaviour.FixedUpdate 消息。
LateUpdate如果启用了 Behaviour，则每帧调用 LateUpdate。
OnAnimatorIK用于设置动画 IK（反向运动学）的回调。
OnAnimatorMove用于处理动画移动以修改根运动的回调。
OnApplicationFocus当玩家获得或失去焦点时，发送给所有 GameObject。
OnApplicationPause当应用程序暂停时，发送给所有 GameObject。
OnApplicationQuit在应用程序退出前，发送给所有游戏对象。
OnAudioFilterRead如果实现了 OnAudioFilterRead，Unity 将在音频 DSP 链中插入一个自定义滤波器。
OnBecameInvisibleOnBecameInvisible 在渲染器对任何摄像机都不可见时调用。
OnBecameVisibleOnBecameVisible 在渲染器变为对任意摄像机可见时调用。
OnCollisionEnter当该碰撞体/刚体已开始接触另一个刚体/碰撞体时，调用 OnCollisionEnter。
OnCollisionEnter2D当传入碰撞体与该对象的碰撞体接触时发送（仅限 2D 物理）。
OnCollisionExit当该碰撞体/刚体已停止接触另一个刚体/碰撞体时，调用 OnCollisionExit。
OnCollisionExit2D当另一个对象上的碰撞体停止接触该对象的碰撞体时发送（仅限 2D 物理）。
OnCollisionStay对应正在接触刚体/碰撞体的每一个碰撞体/刚体，每帧调用一次 :ref::OnCollisionStay。
OnCollisionStay2D在另一个对象上的碰撞体正在接触该对象的碰撞体时发送每个帧（仅限 2D 物理）。
OnConnectedToServer成功连接到服务器后在客户端上调用。
OnControllerColliderHit当该控制器在执行 Move 时撞到碰撞体时调用 OnControllerColliderHit。
OnDestroy销毁附加的行为将导致游戏或场景收到 OnDestroy。
OnDisconnectedFromServer当连接丢失或与服务器断开连接时，在客户端上调用。
OnDrawGizmos如果您想绘制能够选择并且始终绘制的辅助图标，则可以实现 OnDrawGizmos。
OnDrawGizmosSelected如果选择了对象，则实现 OnDrawGizmosSelected 来绘制辅助图标。
OnEnable该函数在对象变为启用和激活状态时调用。
OnFailedToConnect出于某种原因连接尝试失败时，在客户端上调用。
OnFailedToConnectToMasterServer在连接到 MasterServer 时发生问题的情况下，在客户端或服务器上调用。
OnGUI系统调用 OnGUI 来渲染和处理 GUI 事件。
OnJointBreak在附加到相同游戏对象的关节断开时调用。
OnJointBreak2D在附加到相同游戏对象的 Joint2D 断开时调用。
OnMasterServerEvent在从 MasterServer 报告事件时，在客户端或服务器上调用。
OnMouseDown当用户在 GUIElement 或 Collider 上按下鼠标按钮时，将调用 OnMouseDown。
OnMouseDrag当用户单击 GUIElement 或 Collider 并仍然按住鼠标时，将调用 OnMouseDrag。
OnMouseEnter当鼠标进入 GUIElement 或 Collider 时调用。
OnMouseExit当鼠标不再处于 GUIElement 或 Collider 上方时调用。
OnMouseOver当鼠标悬停在 GUIElement 或 Collider 上时，每帧调用一次。
OnMouseUp当用户松开鼠标按钮时，将调用 OnMouseUp。
OnMouseUpAsButton松开鼠标时，仅当鼠标在按下时所在的 GUIElement 或 Collider 上时，才调用 OnMouseUpAsButton。
OnNetworkInstantiate在已通过 Network.Instantiate 进行网络实例化的对象上调用。
OnParticleCollision当粒子击中碰撞体时，将调用 OnParticleCollision。
OnParticleSystemStopped系统中的所有粒子都死亡时，便会调用 OnParticleSystemStopped，然后将不再产生新粒子。在调用 Stop 之后，或者超过非循环系统的 Duration 属性时，将停止产生新粒子。
OnParticleTrigger粒子系统中的任何粒子满足触发模块中的条件时，将调用 OnParticleTrigger。
OnPlayerConnected每当有新玩家成功连接，就在服务器上调用。
OnPlayerDisconnected每当有玩家与服务器断开连接，就在服务器上调用。
OnPostRender在摄像机完成场景渲染后，将调用 OnPostRender。
OnPreCull在摄像机剔除场景前，将调用 OnPreCull。
OnPreRender在摄像机开始渲染场景前，将调用 OnPreRender。
OnRenderImageOnRenderImage 在图像的所有渲染操作全部完成后调用。
OnRenderObject在摄像机渲染场景后，将调用 OnRenderObject。
OnSerializeNetworkView用于在网络视图监视的脚本中自定义变量同步。
OnServerInitialized每当调用 Network.InitializeServer 并且完成时，对该服务器调用该函数。
OnTransformChildrenChanged当 GameObject 的变换的子项列表发生更改时，将调用该函数。
OnTransformParentChanged当 GameObject 的变换的父属性发生更改时，将调用该函数。
OnTriggerEnter GameObject 与另一 GameObject 碰撞时，将调用 OnTriggerEnter。
OnTriggerEnter2D当另一个对象进入附加到该对象的触发碰撞体时发送（仅限 2D 物理）。
OnTriggerExit当 Collider other 已停止接触该触发器时调用 OnTriggerExit。
OnTriggerExit2D当另一个对象离开附加到该对象的触发碰撞体时发送（仅限 2D 物理）。
OnTriggerStay对于接触触发器的每一个 Collider /other/，每次物理更新调用一次 OnTriggerStay。
OnTriggerStay2D在另一个对象位于附加到该对象的触发碰撞体之内时发送每个帧（仅限 2D 物理）。
OnValidate加载脚本后或检视面板中的值发生更改时，将调用此函数（只能在编辑器中调用）。
OnWillRenderObject如果对象可见并且不是 UI 元素，则为每个摄像机调用 OnWillRenderObject。
Reset重置为默认值。
Start在首次调用任何 Update 方法之前启用脚本时，在帧上调用 Start。
Update如果启用了 MonoBehaviour，则每帧调用 Update。
Copyright © 2023 Unity Technologies
优美缔软件（上海）有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961