InputField

class in UnityEngine.UI

实现接口：IBeginDragHandler, ICanvasElement, IDeselectHandler, IDragHandler, IEndDragHandler, IEventSystemHandler, IEventSystemHandler, ILayoutElement, IMoveHandler, IPointerClickHandler, IPointerDownHandler, IPointerEnterHandler, IPointerExitHandler, IPointerUpHandler, ISelectHandler, 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	This is an optional ‘empty’ graphic to show that the InputField text field is empty. Note that this ‘empty' graphic still displays even when the InputField is selected (that is; when there is focus on it).A placeholder graphic can be used to show subtle hints or make it more obvious that the control is an InputField.
readOnly	将 InputField 设置为只读。
selectionAnchorPosition	选择的起点。
selectionColor	突出显示的颜色，以显示选择了哪些字符。
selectionFocusPosition	选择的结束点。
shouldHideMobileInput	应隐藏移动键盘输入。
text	输入字段的当前值。
textComponent	将用于将文本渲染到屏幕的 Text 组件。
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	在事件系统发送提交事件时要执行的操作。
OnUpdateSelected	在事件系统发送 Update selected 事件时要执行的操作。
ProcessEvent	Helper 函数允许 InputField 处理单独的事件。
Rebuild	重新构建输入字段几何形状。（光标和突出显示。）

受保护的函数

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

委托

OnValidateInput

自定义验证回调。

继承的成员

静态变量

allSelectables

场景中当前处于活动状态的所有可选择对象的列表。

变量

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.Selectable.interactable.
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	返回 GameObject 的名称。
FindSelectable	查找此对象旁边的可选择对象。
FindSelectableOnDown	查找此对象下方的可选择对象。
FindSelectableOnLeft	查找此对象左侧的可选择对象。
FindSelectableOnRight	查找此对象右侧的可选择对象。
FindSelectableOnUp	查找此对象上方的可选择对象。
IsInteractable	UI.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	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

InputField

描述

变量

公共函数

受保护的函数

委托

继承的成员

静态变量

变量

公共函数

受保护的函数

静态函数

运算符

消息