Version: 5.3 (switch to 5.4b)
言語English
  • C#
  • JS

スクリプト言語

好きな言語を選択してください。選択した言語でスクリプトコードが表示されます。

InputField

class in UnityEngine.UI

/

継承:UI.Selectable


実装インターフェース:IBeginDragHandler, ICanvasElement, IDeselectHandler, IDragHandler, IEndDragHandler, IEventSystemHandler, IEventSystemHandler, IMoveHandler, IPointerClickHandler, IPointerDownHandler, IPointerEnterHandler, IPointerExitHandler, IPointerUpHandler, ISelectHandler, ISubmitHandler, IUpdateSelectedHandler

フィードバック

ありがとうございます

この度はドキュメントの品質向上のためにご意見・ご要望をお寄せいただき、誠にありがとうございます。頂いた内容をドキュメントチームで確認し、必要に応じて修正を致します。

閉じる

送信に失敗しました

なんらかのエラーが発生したため送信が出来ませんでした。しばらく経ってから<a>もう一度送信</a>してください。ドキュメントの品質向上のために時間を割いて頂き誠にありがとうございます。

閉じる

キャンセル

マニュアルに切り替える

説明

シンプルなラベルをインタラクティブ入力フィールドに変更します。

変数

asteriskCharパスワードフィールドに使用される文字。
caretBlinkRate秒単位の回数として定義された入力キャレットの点滅速度。見える状態と見えない状態を行き来します。
caretColorcustomCaretColor が設定されている場合、カスタムメイドのキャレットカラーを使用できます。
caretPositionInputField 内の現在表示しているキャレット位置(選択範囲の終了位置でもあります)
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 テキストフィールドが空白であることを示します。この「空白」のグラフィックは、たとえ InputField が選択されている場合 (つまり、フォーカスがある場合) でも表示されることに気を付けてください。プレースホルダーグラフィックはわずかなヒントを表示するか、コントロールが InputField であることをより明白にするために使用することができます。
readOnly InputField を読み込み専用に設定します。
selectionAnchorPosition選択範囲の開始位置
selectionColor文字が選択されていることを示すためのハイライトの色。
selectionFocusPosition選択範囲の終了位置
shouldHideMobileInputモバイルキーボードの入力は非表示にするべきです。
text入力フィールドの現在の値。
textComponentテキストをスクリーンにレンダリングするのに使用される Text コンポーネント。
wasCanceled InputField がキャンセルされた場合、DeactivateInputField 上の元のテキストに戻します。

Public 関数

ActivateInputFieldEvents 処理を行う InputField を有効にする機能。
Append文字を InputField に追加します。
ClampPos(参照されている)値を 0 と テキストの長さの間で制限します。
DeactivateInputFieldEvents の処理を停止し、それがキャンセルできなければ OnSubmit の送信を行う関数。
ForceLabelUpdate強制的にラベルを即時更新します。これは、キャレットと表示されている文字列の位置を再計算します。
GetCharacterIndexFromPositionマウスの下にある文字。
GraphicUpdateComplete ICanvasElement.GraphicUpdateComplete を参照してください。
KeyPressed Event を処理し、そのキーに適切なアクションの割り当てを行います。
LayoutComplete ICanvasElement.LayoutComplete を参照してください。
MoveTextEndテキストの最後にキャレットインデックスを移動します。
MoveTextStartテキストの先頭にキャレットインデックスを移動します。
OnBeginDrag EventSystem から OnBeginDrag コールバックを補足し、ドラッグイベントを追従できるようにします。
OnDeselectイベントシステムが Deselect Event を送信するときにどうするか。
OnDisable MonoBehaviour.OnDisable を参照する
OnDragイベントシステムが Drag Event を送信するときにどうするか。
OnEndDrag EventSystem から OnEndDrag コールバックを補足し、ドラッグイベントの追跡をキャンセルします。
OnFocusプロパティーの初期化を行う入力フィールドに注目します。
OnPointerClickイベントシステムがポインタのクリックイベントを送信するときどうするか。
OnPointerDownイベントシステムがポインタのクリックイベントを送信するときどうするか。
OnSubmitイベントシステムが Submit Event を送信するときどうするか。
OnUpdateSelectedイベントシステムが Update selected イベントを送信するときにどうするか。
ProcessEvent別々のイベントが InputField によって処理できるようにするヘルパー関数。
Rebuild入力フィールドのジオメトリ(キャレットやハイライト)を再構築します。
SelectAll InputField 全体をハイライトします。
SendOnSubmit SubmitEvent を送信する機能を作成する便利な関数。
UpdateLabel入力フィールドに関連づけられている Text の更新。
Validate異なる characterValidation タイプ用に事前定義された確認機能。

Protected 関数

Append文字を InputField に追加します。
ClampPos(参照されている)値を 0 と テキストの長さの間で制限します。
GetCharacterIndexFromPositionマウスの下にある文字。
KeyPressed Event を処理し、そのキーに適切なアクションの割り当てを行います。
OnDisable MonoBehaviour.OnDisable を参照する
OnFocusプロパティーの初期化を行う入力フィールドに注目します。
SelectAll InputField 全体をハイライトします。
SendOnSubmit SubmitEvent を送信する機能を作成する便利な関数。
UpdateLabel入力フィールドに関連づけられている Text の更新。
Validate異なる characterValidation タイプ用に事前定義された確認機能。

デリゲート

OnValidateInputカスタム確認コールバック。

継承メンバー

Static 変数

allSelectablesシーン内で現在アクティブなすべての Selectable オブジェクトのリスト。

変数

enabled有効であれば更新され、無効であれば更新されません。
isActiveAndEnabledBehaviour が有効かどうか
gameObjectこのコンポーネントはゲームオブジェクトにアタッチされます。コンポーネントはいつもゲームオブジェクトにアタッチされています。
tagゲームオブジェクトのタグ
transform GameObject にアタッチされた Transform (アタッチされていない場合は null)
useGUILayoutこれを無効にすると、GUI のレイアウトフェーズをスキップすることができます
hideFlagsオブジェクトは非表示、シーンに保存、ユーザーが編集可能、などを設定する。
nameオブジェクト名
animationTriggersこの Selectable オブジェクトのための AnimationTriggers。
animatorGameObject の Animator コンポーネントを取得するための便利関数。
colorsこの Selectable オブジェクトのための ColorBlock。
image可能であれば、参照されたグラフィックを Image に変換する便利な関数。
interactableUI.Selectable.interactable。
navigationこの Selectable オブジェクトへの Navigation 設定。
spriteStateこの Selectable オブジェクトのための SpriteState。
targetGraphic遷移使用されるグラフィック。
transitionステートが変更するときに targetGraphic に適用される遷移の種類。

Public 関数

BroadcastMessageゲームオブジェクトまたは子オブジェクトにあるすべての MonoBehaviour を継承したクラスにある methodName 名のメソッドを呼び出します。
CompareTagこのゲームオブジェクトは tag とタグ付けされているかどうか
GetComponentゲームオブジェクトに type がアタッチされている場合は type のタイプを使用してコンポーネントを返します。ない場合は null です
GetComponentInChildren GameObject や深さ優先探索を活用して、親子関係にある子オブジェクトから type のタイプのコンポーネントを取得します。
GetComponentInParent GameObject や深さ優先探索を活用して、親子関係にある親オブジェクトから type のタイプのコンポーネントを取得します。
GetComponents GameObject から type のタイプのコンポーネントを「すべて」取得します。
GetComponentsInChildren GameObject や深さ優先探索を活用して、親子関係にある子オブジェクトから type のタイプのコンポーネントを「すべて」取得します。
GetComponentsInParent GameObject や深さ優先探索を活用して、親子関係にある親オブジェクトから type のタイプのコンポーネントを「すべて」取得します。
SendMessageゲームオブジェクトにアタッチされているすべての MonoBehaviour にある methodName と名付けたメソッドを呼び出します
SendMessageUpwardsゲームオブジェクトと親(の親、さらに親 ... )にアタッチされているすべての MonoBehaviour にある methodName と名付けたメソッドを呼び出します
CancelInvokeすべての Invoke をキャンセルします
Invoke設定した時間(単位は秒)にメソッドを呼び出します
InvokeRepeating設定した時間(単位は秒)にメソッドを呼び出し、repeatRate 秒ごとにリピートします
IsInvokingメソッドの呼出が保留中かどうか
StartCoroutineコルーチンを開始します
StopAllCoroutinesBehaviour 上で実行されているコルーチンをすべて停止します
StopCoroutineこの Behaviour 上で実行されている methodName という名のコルーチン、または routine として保持されているコルーチンをすべて停止します
GetInstanceIDオブジェクトのインスタンス ID を返します
ToStringゲームオブジェクトの名前を返します
DoStateTransitionSelectable を入力されたステートへ遷移させます。
FindSelectableこの次の Selectable オブジェクトを一つ検索します。
FindSelectableOnDown以下にある Selectable オブジェクトを一つ検索します。
FindSelectableOnLeftこのオブジェクトの左にある Selectable オブジェクトを一つ検索します。
FindSelectableOnRightこのオブジェクトの右にある Selectable オブジェクトを一つ検索します。
FindSelectableOnUpこのオブジェクトの上にある Selectable オブジェクトを検索します。
InstantClearState(無効のときに使用される) Selectable の内部状態をクリアします。
IsHighlighted現在「ハイライト表示」されている Selectable です。
IsInteractableUI.Selectable.IsInteractable。
OnMove次の Selectable オブジェクトを見つける方向を 4 つの移動方向から決定します。
OnPointerEnter現在のステートと、適切なステートへの遷移を評価します。
OnPointerExit現在のステートと通常ステートへの遷移を評価します
OnPointerUpeventData と適切なステートへの遷移を評価します。
OnSelect選択と適切なステートへの遷移を設定します。
Selectこの Selectable を選択します。
UpdateSelectionState内部的に Selectable の選択状態を更新します。
Awake MonoBehaviour.Awake を参照してください
IsActive GameObject と Component がアクティブになっている場合は true を返します。
IsDestroyedネイティブ表示の振る舞いが破棄された場合は true を返します。
OnBeforeTransformParentChangedMonoBehaviour.OnBeforeTransformParentChanged を参照してください
OnCanvasGroupChangedMonoBehaviour.OnCanvasGroupChanged を参照してください
OnCanvasHierarchyChanged親の Canvas の状態が変更されたとき呼び出されます。
OnDestroy MonoBehaviour.OnDestroy を参照してください
OnDidApplyAnimationProperties LayoutGroup.OnDidApplyAnimationProperties を参照してください
OnEnable MonoBehaviour.OnEnable を参照してください
OnRectTransformDimensionsChange関連する RectTransform の寸法が変わると、このコールバックは呼び出されます。この呼び出しは、たとえ子のトランスフォーム自体変化がなくとも、あたかも変化があったようにすべての子矩形のトランスフォームにも行われます。
OnTransformParentChangedMonoBehaviour.OnRectTransformParentChanged を参照してください
OnValidate MonoBehaviour.OnValidate を参照してください
Reset MonoBehaviour.Reset を参照してください
Start MonoBehaviour.Start を参照してください

Protected 関数

DoStateTransitionSelectable を入力されたステートへ遷移させます。
InstantClearState(無効のときに使用される) Selectable の内部状態をクリアします。
IsHighlighted現在「ハイライト表示」されている Selectable です。
UpdateSelectionState内部的に Selectable の選択状態を更新します。
Awake MonoBehaviour.Awake を参照してください
OnBeforeTransformParentChangedMonoBehaviour.OnBeforeTransformParentChanged を参照してください
OnCanvasGroupChangedMonoBehaviour.OnCanvasGroupChanged を参照してください
OnCanvasHierarchyChanged親の Canvas の状態が変更されたとき呼び出されます。
OnDestroy MonoBehaviour.OnDestroy を参照してください
OnDidApplyAnimationProperties LayoutGroup.OnDidApplyAnimationProperties を参照してください
OnEnable MonoBehaviour.OnEnable を参照してください
OnRectTransformDimensionsChange関連する RectTransform の寸法が変わると、このコールバックは呼び出されます。この呼び出しは、たとえ子のトランスフォーム自体変化がなくとも、あたかも変化があったようにすべての子矩形のトランスフォームにも行われます。
OnTransformParentChangedMonoBehaviour.OnRectTransformParentChanged を参照してください
OnValidate MonoBehaviour.OnValidate を参照してください
Reset MonoBehaviour.Reset を参照してください
Start MonoBehaviour.Start を参照してください

Static 関数

printUnity コンソールにログを出力します (Debug.Log と同じです)
Destroyゲームオブジェクトやコンポーネント、アセットを削除します
DestroyImmediate直ちにオブジェクトを破壊する (Destroy 関数の方を使うことを推奨します)
DontDestroyOnLoad新しいシーンを読み込んでもオブジェクトが自動で破壊されないように設定します
FindObjectOfTypeタイプ type から最初に見つけたアクティブのオブジェクトを返します
FindObjectsOfTypeタイプから見つけたすべてのアクティブのオブジェクト配列を返します
Instantiateオブジェクト original のコピーを返します

Operator

boolオブジェクトが存在するかどうか
operator !=二つのオブジェクトが異なるオブジェクトを参照しているか比較します
operator ==2つのオブジェクト参照が同じオブジェクトを参照しているか比較します。

メッセージ

Awakeスクリプトのインスタンスがロードされたときに呼び出されます
FixedUpdateMonoBehaviour が有効の場合、この関数は毎回、固定フレームレートで呼び出されます。
LateUpdate Behaviour が有効の場合、LateUpdate は毎フレーム呼びだされます
OnAnimatorIKアニメーション IK (インバースキネマティクス)をセットアップするときのコールバック
OnAnimatorMoveルートモーションを修正するアニメーション動作を処理するコールバック
OnApplicationFocusプレイヤーの取得またはフォーカスを失ったときにすべてのゲームオブジェクトに送信されます。
OnApplicationPauseプレイヤーが一時停止したときにすべてのゲームオブジェクトに送信されます
OnApplicationQuitアプリケーションが終了する前にすべてのゲームオブジェクトで呼び出されます
OnAudioFilterReadOnAudioFilterRead が実装されている場合、Unity は DSP チェーンにカスタムフィルターを挿入します。
OnBecameInvisibleOnBecameInvisible はレンダラーがカメラから見えなくなったときに呼び出されます
OnBecameVisibleOnBecameVisible はレンダラーが任意のカメラから見えるようになると呼び出されます
OnCollisionEnterOnCollisionEnter はコライダー/Rigidbody が他のコライダー/Rigidbody に触れたときに呼び出されます
OnCollisionEnter2Dこのオブジェクトのコライダーに他のコライダーが接触したときに送信されます(2D Physics のみ)
OnCollisionExitOnCollisionExit はコライダー/Rigidbody と他のコライダー/Rigidbody の接触が終了したときに呼び出されます
OnCollisionExit2Dこのオブジェクトのコライダーと他のコライダーの接触が終わったときに送信されます(2D Physics のみ)
OnCollisionStayOnCollisionStay はコライダー/Rigidbody と他のコライダー/Rigidbody が接触し続けて毎フレームに一度呼び出されます
OnCollisionStay2Dこのオブジェクトのコライダーに他のコライダーが接触し続けている毎フレームの間、送信されます(2D Physics のみ)
OnConnectedToServerサーバーとの接続に成功したときにクライアント上で呼び出されます
OnControllerColliderHitOnControllerColliderHit は移動中にコントローラーがコライダーにヒットしたときに呼び出されます
OnDestroyこの関数は MonoBehaviour が破棄されるときに呼び出されます
OnDisconnectedFromServerサーバーとの接続が失われたか切断されたときにクライアント上で呼び出されます
OnDrawGizmos選択可能にしたり、常に描画したいギズモを描画するには OnDrawGizmos を使用します
OnDrawGizmosSelected選択しているオブジェクトのみのギズモを描画したい場合は OnDrawGizmosSelected を使用します
OnEnableこの関数はオブジェクトが有効/アクティブになったときに呼び出されます
OnFailedToConnect接続試行がなんらかの理由で失敗したときにクライアント上で呼び出されます
OnFailedToConnectToMasterServerMasterServer への接続に問題がある場合に、クライアントまたはサーバーで呼び出されます
OnGUIOnGUI はレンダリングと GUI イベントのハンドリングのために呼び出されます
OnJointBreakゲームオブジェクトのジョイントが壊れたときに呼び出されます
OnJointBreak2Dゲームオブジェクトにアタッチされた Joint2D が壊れたときに呼び出されます
OnLevelWasLoadedこの関数は新しいレベルがロードされた後に呼び出されます
OnMasterServerEventMasterServer からイベントを報告してくるときにクライアントまたはサーバー上で呼び出されます
OnMouseDownOnMouseDown は GUIElement または Collider 上でユーザーがマウスボタンをクリックしたときに呼び出されます
OnMouseDragOnMouseDrag はユーザーが GUIElement または Collider をマウスでクリックし、ドラッグしている間呼び出されます。
OnMouseEnterOnMouseEnter は GUIElement または Collider 上にマウスが乗ったときに呼び出されます
OnMouseExitOnMouseExit は GUIElement または Collider 上からマウス離れたときに呼び出されます
OnMouseOverOnMouseOver は GUIElement または Collider 上にマウスがあり続ける限り毎フレーム呼び出され続けます
OnMouseUpOnMouseUp はユーザーがマウスボタンを離したときに呼び出されます
OnMouseUpAsButtonOnMouseUpAsButton はマウスを押した時と同じ GUIElement や Collider 上でマウスを離した時のみに呼び出されます。
OnNetworkInstantiateNetwork.Instantiate でインスタンス化されたオブジェクトに対して呼び出されます
OnParticleCollisionOnParticleCollision はパーティクルがコライダーにヒットしたときに呼び出されます
OnPlayerConnected新しいプレイヤーが接続に成功したときにサーバー上で呼び出されます
OnPlayerDisconnectedプレイヤーがサーバーから接続が切断されるたびにサーバー上で呼び出されます
OnPostRenderOnPostRender はカメラがシーンのレンダリングを完了した後に呼び出されます
OnPreCullOnPreCull はカメラがシーンをカリングする前に呼び出されます
OnPreRenderOnPreRender はカメラがシーンのレンダリングを始める前に呼び出されます
OnRenderImageOnRenderImage はすべてのレンダリングが完了し RenterTexture にレンダリングされた後に呼び出されます
OnRenderObjectOnRenderObject はカメラがシーンのレンダリングを行った後に呼び出されます
OnSerializeNetworkViewネットワークビューによって監視されるスクリプトの変数の同期をカスタマイズするために使用します
OnServerInitializedNetwork.InitializeServer が実行され完了したときにサーバー上で呼び出されます
OnTransformChildrenChangedこの関数は GameObject の Transform のすべての子の中で変更があったときに呼び出されます
OnTransformParentChangedこの関数は GameObject の Transform の parent プロパティーに変更があったときに呼び出されます
OnTriggerEnterOnTriggerEnter は Collider が他のトリガーに入ったときに呼び出されます
OnTriggerEnter2Dトリガーコライダーをアタッチしたオブジェクトが他のオブジェクトに接触したときに送信されます(2D Physics のみ)
OnTriggerExitOnTriggerExit は Collider が他のトリガーから出たときに呼び出されます
OnTriggerExit2Dトリガーコライダーをアタッチしたオブジェクトが他のオブジェクトと接触が終わったときに送信されます(2D Physics のみ)
OnTriggerStayOnTriggerStay は Collider が他のトリガーと当たり続けている毎フレーム呼び出されます
OnTriggerStay2Dトリガーコライダーをアタッチしたオブジェクトが他のオブジェクトと接触し続けている時に毎フレーム送信されます(2D Physics のみ)
OnValidateこの関数はスクリプトがロードされた時やインスペクターの値が変更されたときに呼び出されます(この呼出はエディター上のみ)
OnWillRenderObjectOnWillRenderObject はオブジェクトが表示されている場合カメラごとに 1 度呼び出されます
Resetデフォルト値にリセットします
StartStart はスクリプトが有効で、Update メソッドが最初に呼び出される前のフレームで呼び出されます
UpdateUpdate は MonoBehaviour が有効の場合に、毎フレーム呼び出されます