Version: 2017.2


Turn a simple label into a interactable input field.


asteriskCharThe character used for password fields.
caretBlinkRateThe blinking rate of the input caret, defined as the number of times the blink cycle occurs per second.
caretColorThe custom caret color used if customCaretColor is set.
caretPositionCurrent InputField caret position (also selection tail).
caretWidthThe width of the caret in pixels.
characterLimitHow many characters the input field is limited to. 0 = infinite.
characterValidationThe type of validation to perform on a character.
contentTypeSpecifies the type of the input text content.
customCaretColorShould a custom caret color be used or should the textComponent.color be used.
inputTypeThe type of input expected. See InputField.InputType.
isFocusedDoes the InputField currently have focus and is able to process events.
keyboardTypeThey type of mobile keyboard that will be used.
lineTypeThe LineType used by the InputField.
multiLineIf the input field supports multiple lines.
onEndEditThe Unity Event to call when editing has ended.
onValidateInputThe function to call to validate the input characters.
onValueChangedAccessor to the OnChangeEvent.
placeholderThis 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.
readOnlySet the InputField to be read only.
selectionAnchorPositionThe beginning point of the selection.
selectionColorThe color of the highlight to show which characters are selected.
selectionFocusPositionThe end point of the selection.
shouldHideMobileInputShould the mobile keyboard input be hidden.
textThe current value of the input field.
textComponentThe Text component that is going to be used to render the text to screen.
wasCanceledIf the InputField was canceled and will revert back to the original text upon DeactivateInputField.

Public Functions

ActivateInputFieldFunction to activate the InputField to begin processing Events.
DeactivateInputFieldFunction to deactivate the InputField to stop the processing of Events and send OnSubmit if not canceled.
ForceLabelUpdateForce the label to update immediatly. This will recalculate the positioning of the caret and the visible text.
GraphicUpdateCompleteSee ICanvasElement.GraphicUpdateComplete.
LayoutCompleteSee ICanvasElement.LayoutComplete.
MoveTextEndMove the caret index to end of text.
MoveTextStartMove the caret index to start of text.
OnBeginDragCapture the OnBeginDrag callback from the EventSystem and ensure we should listen to the drag events to follow.
OnDeselectWhat to do when the event system sends a Deselect Event.
OnDragWhat to do when the event system sends a Drag Event.
OnEndDragCapture the OnEndDrag callback from the EventSystem and cancel the listening of drag events.
OnPointerClickWhat to do when the event system sends a pointer click Event.
OnPointerDownWhat to do when the event system sends a pointer down Event.
OnSubmitWhat to do when the event system sends a submit Event.
OnUpdateSelectedWhat to do when the event system sends a Update selected Event.
ProcessEventHelper function to allow separate events to be processed by the InputField.
RebuildRebuild the input fields geometry. (caret and highlight).

Protected Functions

AppendAppend a character to the input field.
ClampPosClamp a value (by reference) between 0 and the current text length.
GetCharacterIndexFromPositionThe character that is under the mouse.
KeyPressedProcess the Event and perform the appropriate action for that key.
OnDisableСм. MonoBehaviour.OnDisable.
OnFocusFocus the input field initializing properties.
SelectAllHighlight the whole InputField.
SendOnSubmitConvenience function to make functionality to send the SubmitEvent easier.
UpdateLabelUpdate the Text associated with this input field.
ValidatePredefined validation functionality for different characterValidation types.


OnValidateInputCustom validation callback.

Inherited members

Static Variables

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


enabledВключенное Поведение обновляется, выключенное Поведение не обновляется.
isActiveAndEnabledHas the Behaviour had enabled called.
gameObjectИгровой объект к которому прикреплён данный компонент. Компонент всегда прикреплён к игровому объекту.
tagТег данного игрового объекта.
transformThe Transform attached to this GameObject.
runInEditModeAllow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor).
useGUILayoutDisabling this lets you skip the GUI layout phase.
hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.
animationTriggersThe AnimationTriggers for this selectable object.
animatorConvenience function to get the Animator component on the GameObject.
colorsThe ColorBlock for this selectable object.
imageConvenience function that converts the referenced Graphic to a Image, if possible.
navigationThe Navigation setting for this selectable object.
spriteStateThe SpriteState for this selectable object.
targetGraphicGraphic that will be transitioned upon.
transitionThe type of transition that will be applied to the targetGraphic when the state changes.

Public Functions

BroadcastMessageВызывает метод названный methodName на каждом MonoBehaviour этого game object-а или любого из его потомков.
CompareTagПомечен ли данный игровой объект тегом tag?
GetComponentВозвращает компонент типа type, если он прикреплен к игровому объекту и null, если не прикреплен.
GetComponentInChildrenВозвращает компонент типа type в GameObject или некоторого его потомка через поиск в глубину.
GetComponentInParentВозвращает все компоненты типа type из GameObject'а или из любого его родителя.
GetComponentsВозвращает все компоненты типа type в GameObject.
GetComponentsInChildrenВозвращает все компоненты типа type в GameObject или любому из его потомков.
GetComponentsInParentВозвращает все компоненты типа type в GameObject или любому из его родителей.
SendMessageВызывает метод с названием methodName в каждом MonoBehaviour в этом игровом объекте.
SendMessageUpwardsВызывает метод с именем methodName в каждом MonoBehaviour в этом игровом объекте и в каждом предке поведения.
CancelInvokeОтменяет все вызовы Invoke в этом MonoBehaviour.
InvokeВызывает метод methodName по истечении времени time секунд.
InvokeRepeatingВызывает метод methodName по истечении времени time секунд, затем повторяет вызов каждые repeatRate секунд.
IsInvokingЕсть ли какой то ожидающий вызов methodName?
StartCoroutineЗапуск корутины.
StopAllCoroutinesОстанавливает все корутины запущенные на этом MonoBehaviour.
StopCoroutineОстанавливает все корутины с именем methodName запущенные на этом MonoBehaviour.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.
FindSelectableFinds the selectable object next to this one.
FindSelectableOnDownFind the selectable object below this one.
FindSelectableOnLeftFind the selectable object to the left of this one.
FindSelectableOnRightFind the selectable object to the right of this one.
FindSelectableOnUpFind the selectable object above this one.
OnMoveDetermine in which of the 4 move directions the next selectable object should be found.
OnPointerEnterEvaluate current state and transition to appropriate state.
OnPointerExitEvaluate current state and transition to normal state.
OnPointerUpEvaluate eventData and transition to appropriate state.
OnSelectSet selection and transition to appropriate state.
SelectSelects this Selectable.
IsActiveВозвращает true если GameObject и Component активны.
IsDestroyedВозвращает true если родное представление поведения было разрушено.

Protected Functions

DoStateTransitionTransition the Selectable to the entered state.
InstantClearStateClear any internal state from the Selectable (used when disabling).
IsHighlightedIs the selectable currently 'highlighted'.
IsPressedWhether the current selectable is being pressed.
UpdateSelectionStateInternally update the selection state of the Selectable.
AwakeСм. MonoBehaviour.Awake.
OnBeforeTransformParentChangedСм. MonoBehaviour.OnBeforeTransformParentChanged.
OnCanvasGroupChangedСм. MonoBehaviour.OnCanvasGroupChanged.
OnCanvasHierarchyChangedCalled when the state of the parent Canvas is changed.
OnDestroyСм. MonoBehaviour.OnDestroy.
OnDidApplyAnimationPropertiesСм. MonoBehaviour.OnDidApplyAnimationProperties.
OnEnableСм. MonoBehaviour.OnEnable.
OnRectTransformDimensionsChangeThis 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.

Static Functions

printLogs message to the Unity Console (identical to Debug.Log).
DestroyУдаляет GameObject, Component или Asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.


boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.


AwakeФункция Awake вызывается когда экземпляр скрипта будет загружен.
FixedUpdateЭта функция вызывается с частотой фиксированных кадров (fixed framerate), если MonoBehaviour включен.
LateUpdateLateUpdate вызывается каждый кадр, если Behaviour включен.
OnAnimatorIKОбратный вызов (Callback) для установки IK анимации (инверсной кинематики).
OnAnimatorMoveОбратный вызов для обработки перемещения анимации для модификации смещения корня.
OnApplicationFocusПосылается ко всем игровым объектам когда плейер получает или теряет фокус.
OnApplicationPauseПосылается ко всем игровым объектам когда плейер на паузе.
OnApplicationQuitSent to all game objects before the application is quit.
OnAudioFilterReadIf OnAudioFilterRead is implemented, Unity will insert a custom filter into the audio DSP chain.
OnBecameInvisibleOnBecameInvisible is called when the renderer is no longer visible by any camera.
OnBecameVisibleOnBecameVisible is called when the renderer became visible by any camera.
OnCollisionEnterOnCollisionEnter вызывается, когда этот collider/rigidbody начал соприкосновение с другим rigidbody/collider.
OnCollisionEnter2DПередается когда входящий коллайдер контактирует с коллайдером данного объекта (только 2D физика).
OnCollisionExitOnCollisionExit вызывается, когда collider/rigidbody прекращает контакт с другим rigidbody/collider.
OnCollisionExit2DПередается, когда коллайдер другого объекта перестает соприкасаться с коллайдером этого объекта (только 2D физика).
OnCollisionStayOnCollisionStay вызывается один раз в кадр для каждого collider/rigidbody, который касается другого rigidbody/collider.
OnCollisionStay2DПередается каждый кадр, пока коллайдер другого объекта контактирует с коллайдером данного объекта (только 2D физика).
OnConnectedToServerCalled on the client when you have successfully connected to a server.
OnControllerColliderHitOnControllerColliderHit вызывается тогда, когда контроллер сталкивается с коллайдеров, во время выполнения метода Move.
OnDestroyThis function is called when the MonoBehaviour will be destroyed.
OnDisconnectedFromServerCalled on the client when the connection was lost or you disconnected from the server.
OnDrawGizmosImplement OnDrawGizmos if you want to draw gizmos that are also pickable and always drawn.
OnDrawGizmosSelectedImplement OnDrawGizmosSelected to draw a gizmo if the object is selected.
OnEnableThis function is called when the object becomes enabled and active.
OnFailedToConnectCalled on the client when a connection attempt fails for some reason.
OnFailedToConnectToMasterServerCalled on clients or servers when there is a problem connecting to the MasterServer.
OnGUIOnGUI is called for rendering and handling GUI events.
OnJointBreakВызывается при разрушении сустава, прикрепленного к такому же игровому объекту.
OnJointBreak2DCalled when a Joint2D attached to the same game object breaks.
OnMasterServerEventCalled on clients or servers when reporting events from the MasterServer.
OnMouseDownOnMouseDown is called when the user has pressed the mouse button while over the GUIElement or Collider.
OnMouseDragOnMouseDrag is called when the user has clicked on a GUIElement or Collider and is still holding down the mouse.
OnMouseEnterCalled when the mouse enters the GUIElement or Collider.
OnMouseExitCalled when the mouse is not any longer over the GUIElement or Collider.
OnMouseOverCalled every frame while the mouse is over the GUIElement or Collider.
OnMouseUpOnMouseUp is called when the user has released the mouse button.
OnMouseUpAsButtonOnMouseUpAsButton is only called when the mouse is released over the same GUIElement or Collider as it was pressed.
OnNetworkInstantiateCalled on objects which have been network instantiated with Network.Instantiate.
OnParticleCollisionOnControllerColliderHit вызывается тогда, когда контроллер сталкивается с коллайдеров, во время выполнения метода Move.
OnParticleTriggerOnParticleTrigger is called when any particles in a particle system meet the conditions in the trigger module.
OnPlayerConnectedCalled on the server whenever a new player has successfully connected.
OnPlayerDisconnectedCalled on the server whenever a player disconnected from the server.
OnPostRenderOnPostRender is called after a camera finished rendering the scene.
OnPreCullOnPreCull вызывается до того, как камера отсечёт сцену.
OnPreRenderOnPreRender вызывается перед тем, как камера начнёт рендерить сцену.
OnRenderImageOnRenderImage вызывается после того как весь рендеринг для отрисовки изображения завершиться.
OnRenderObjectOnRenderObject вызывается после того, как камера отрендерила сцену.
OnSerializeNetworkViewUsed to customize synchronization of variables in a script watched by a network view.
OnServerInitializedCalled on the server whenever a Network.InitializeServer was invoked and has completed.
OnTransformChildrenChangedThis function is called when the list of children of the transform of the GameObject has changed.
OnTransformParentChangedThis function is called when the parent property of the transform of the GameObject has changed.
OnTriggerEnterOnTriggerEnter вызывается, когда Collider other входит в триггер.
OnTriggerEnter2DПередается, когда другой обьект входит в триггер присоединенный к данному обьекту (только 2D физика).
OnTriggerExitOnTriggerExit вызывается, когда Collider other перестает соприкасаться с триггером.
OnTriggerExit2DПередается когда другой объект покидает триггер, присоединенный к данному объекту(только 2D физика).
OnTriggerStayOnTriggerStay is called once per physics update for every Collider other that is touching the trigger.
OnTriggerStay2DПередается каждый кадр, пока другой объект находится в триггере, присоединенном к этому объекту (только 2D физика).
OnValidateЭта функция вызывается когда скрипт загружается или изменяется значение в Инспекторе (Вызывается только в редакторе).
OnWillRenderObjectOnWillRenderObject вызвается один раз для каждой камеры, если объект в зоне видимости.
ResetReset to default values.
StartStart is called on the frame when a script is enabled just before any of the Update methods is called the first time.
UpdateUpdate вызывается каждый кадр, если MonoBehaviour включен.