Button
Toggle Group

Toggle

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Toggleコントロールはユーザーがオプションのオンとオフを切り替えることができるチェックボックスです。

A Toggle.
A Toggle.

Properties

Property: Function:
Interactable コンポーネンがインプットを受け付けるかどうか。 Interactableを参照。
Transition ユーザーのアクションに対してビジュアル面でのコントロールの反応の仕方を決定するプロパティです。Transition Optionsを参照。
Navigation コントロールの配列を決定するプロパティです。Navigation Optionsを参照。
Is On トグルのスイッチが初めからオンになっているかどうか。
Toggle Transition 値が変更された時のトグルのグラフィック的な反応の仕方です。オプションは_None(例:チェックマークは単純に表示と非表示)と_Fade(例:チェックマークがフェードインもしくはフェードアウトする)。
Graphic チェックマークで使用する画像。
Group Toggle Group は(もしあれば) トグルが属するグループです。

Events

Property: Function:
On Value Changed UnityEvent はトグルがクリックされた時に呼び出されるイベントです。イベントはbool型のダイナミック引数として送ることが可能です。

Details

また,複数のトグルを一つのToggle Groupに結合させることも可能です。オプションのセットの一つのみを一度にオンにすることができます。

トグルには_On Value Changed_と呼ばれるシングルイベントがあります。これはユーザーが現在の値を変更した時に応答します。新しい値はbooleanパラメーターとしてイベントファンクションに渡されます。トグルの含まれる一般的な使用例は:

  • オプションのオンとオフの切り替え(例:ゲーム中の音楽再生)
  • ユーザーが法的放棄声明文を読んだ事を認証させる。
  • トグルグループ使用時にオプションセットのうち一つ(例:一週間の中の1日)を選択する。
Button
Toggle Group