表示テーマ
UISelectable Component
通常・選択・決定・無効の見た目と操作可能状態を設定します。
設定する手順
- 画像や文字のRendererと組み合わせ、状態ごとの色・拡縮・音・Animationを指定します。
- SceneViewまたはGameViewで結果を確認します。
- 編集中のSceneまたはPrefabを保存します。
項目の説明
| 項目 | C#名 | 型 | 操作 | 定義時の初期値 | 意味 |
|---|---|---|---|---|---|
| 入力操作対象、アクティブ設定 | Interactable | bool | 読取・変更 | true | UI操作を受け付けます。無効時はDisabledの見た目になります。 |
| NormalAnimationEnabled | NormalAnimationEnabled | bool | 読取・変更 | true | 通常状態:UI状態遷移のAnimationを有効にします。 |
| NormalColor | NormalColor | Color4 | 読取・変更 | Color4::White() | 通常状態:色を指定します。RGBAではAlphaも持ちます。 |
| NormalScale | NormalScale | Vector2 | 読取・変更 | Vector2::AnyInit(1.0f) | 通常状態:拡縮倍率です。 |
| NormalColorTransitionDuration | NormalColorTransitionDuration | float | 読取・変更 | 0.08f | 通常状態:UI状態の色を切り替える秒数です。 |
| NormalColorEasing | NormalColorEasing | EasingType | 読取・変更 | EasingType::Linear | 通常状態:色遷移のEasingです。 |
| NormalScaleTransitionDuration | NormalScaleTransitionDuration | float | 読取・変更 | 0.08f | 通常状態:UI状態の拡縮を切り替える秒数です。 |
| NormalScaleEasing | NormalScaleEasing | EasingType | 読取・変更 | EasingType::Linear | 通常状態:拡縮遷移のEasingです。 |
| NormalOverrideTexture | NormalOverrideTexture | bool | 読取・変更 | false | 通常状態:UI状態専用のTextureを使います。 |
| NormalTexture | NormalTexture | Texture? | 読取・変更 | {} | 通常状態:画像Assetの参照です。 |
| NormalUseAnimationClip | NormalUseAnimationClip | bool | 読取・変更 | false | 通常状態:UI状態に専用AnimationClipを使います。 |
| NormalAnimationClip | NormalAnimationClip | AnimationClip? | 読取・変更 | {} | 通常状態:UI状態で再生するAnimationClipです。 |
| NormalSound | NormalSound | AudioClip? | 読取・変更 | {} | 通常状態:UI状態変化時に再生する音です。 |
| NormalSoundVolume | NormalSoundVolume | float | 読取・変更 | 1.0f | 通常状態:UI状態変化の効果音の音量です。 |
| SelectedAnimationEnabled | SelectedAnimationEnabled | bool | 読取・変更 | 追加時の設定を参照 | 選択状態:UI状態遷移のAnimationを有効にします。 |
| SelectedColor | SelectedColor | Color4 | 読取・変更 | 追加時の設定を参照 | 選択状態:色を指定します。RGBAではAlphaも持ちます。 |
| SelectedScale | SelectedScale | Vector2 | 読取・変更 | 追加時の設定を参照 | 選択状態:拡縮倍率です。 |
| SelectedColorTransitionDuration | SelectedColorTransitionDuration | float | 読取・変更 | 追加時の設定を参照 | 選択状態:UI状態の色を切り替える秒数です。 |
| SelectedColorEasing | SelectedColorEasing | EasingType | 読取・変更 | 追加時の設定を参照 | 選択状態:色遷移のEasingです。 |
| SelectedScaleTransitionDuration | SelectedScaleTransitionDuration | float | 読取・変更 | 追加時の設定を参照 | 選択状態:UI状態の拡縮を切り替える秒数です。 |
| SelectedScaleEasing | SelectedScaleEasing | EasingType | 読取・変更 | 追加時の設定を参照 | 選択状態:拡縮遷移のEasingです。 |
| SelectedOverrideTexture | SelectedOverrideTexture | bool | 読取・変更 | 追加時の設定を参照 | 選択状態:UI状態専用のTextureを使います。 |
| SelectedTexture | SelectedTexture | Texture? | 読取・変更 | 追加時の設定を参照 | 選択状態:画像Assetの参照です。 |
| SelectedUseAnimationClip | SelectedUseAnimationClip | bool | 読取・変更 | 追加時の設定を参照 | 選択状態:UI状態に専用AnimationClipを使います。 |
| SelectedAnimationClip | SelectedAnimationClip | AnimationClip? | 読取・変更 | 追加時の設定を参照 | 選択状態:UI状態で再生するAnimationClipです。 |
| SelectedSound | SelectedSound | AudioClip? | 読取・変更 | 追加時の設定を参照 | 選択状態:UI状態変化時に再生する音です。 |
| SelectedSoundVolume | SelectedSoundVolume | float | 読取・変更 | 追加時の設定を参照 | 選択状態:UI状態変化の効果音の音量です。 |
| SubmittedAnimationEnabled | SubmittedAnimationEnabled | bool | 読取・変更 | 追加時の設定を参照 | 決定状態:UI状態遷移のAnimationを有効にします。 |
| SubmittedColor | SubmittedColor | Color4 | 読取・変更 | 追加時の設定を参照 | 決定状態:色を指定します。RGBAではAlphaも持ちます。 |
| SubmittedScale | SubmittedScale | Vector2 | 読取・変更 | 追加時の設定を参照 | 決定状態:拡縮倍率です。 |
| SubmittedColorTransitionDuration | SubmittedColorTransitionDuration | float | 読取・変更 | 追加時の設定を参照 | 決定状態:UI状態の色を切り替える秒数です。 |
| SubmittedColorEasing | SubmittedColorEasing | EasingType | 読取・変更 | 追加時の設定を参照 | 決定状態:色遷移のEasingです。 |
| SubmittedScaleTransitionDuration | SubmittedScaleTransitionDuration | float | 読取・変更 | 追加時の設定を参照 | 決定状態:UI状態の拡縮を切り替える秒数です。 |
| SubmittedScaleEasing | SubmittedScaleEasing | EasingType | 読取・変更 | 追加時の設定を参照 | 決定状態:拡縮遷移のEasingです。 |
| SubmittedOverrideTexture | SubmittedOverrideTexture | bool | 読取・変更 | 追加時の設定を参照 | 決定状態:UI状態専用のTextureを使います。 |
| SubmittedTexture | SubmittedTexture | Texture? | 読取・変更 | 追加時の設定を参照 | 決定状態:画像Assetの参照です。 |
| SubmittedUseAnimationClip | SubmittedUseAnimationClip | bool | 読取・変更 | 追加時の設定を参照 | 決定状態:UI状態に専用AnimationClipを使います。 |
| SubmittedAnimationClip | SubmittedAnimationClip | AnimationClip? | 読取・変更 | 追加時の設定を参照 | 決定状態:UI状態で再生するAnimationClipです。 |
| SubmittedSound | SubmittedSound | AudioClip? | 読取・変更 | 追加時の設定を参照 | 決定状態:UI状態変化時に再生する音です。 |
| SubmittedSoundVolume | SubmittedSoundVolume | float | 読取・変更 | 追加時の設定を参照 | 決定状態:UI状態変化の効果音の音量です。 |
| DisabledAnimationEnabled | DisabledAnimationEnabled | bool | 読取・変更 | 追加時の設定を参照 | 無効状態:UI状態遷移のAnimationを有効にします。 |
| DisabledColor | DisabledColor | Color4 | 読取・変更 | 追加時の設定を参照 | 無効状態:色を指定します。RGBAではAlphaも持ちます。 |
| DisabledScale | DisabledScale | Vector2 | 読取・変更 | 追加時の設定を参照 | 無効状態:拡縮倍率です。 |
| DisabledColorTransitionDuration | DisabledColorTransitionDuration | float | 読取・変更 | 追加時の設定を参照 | 無効状態:UI状態の色を切り替える秒数です。 |
| DisabledColorEasing | DisabledColorEasing | EasingType | 読取・変更 | 追加時の設定を参照 | 無効状態:色遷移のEasingです。 |
| DisabledScaleTransitionDuration | DisabledScaleTransitionDuration | float | 読取・変更 | 追加時の設定を参照 | 無効状態:UI状態の拡縮を切り替える秒数です。 |
| DisabledScaleEasing | DisabledScaleEasing | EasingType | 読取・変更 | 追加時の設定を参照 | 無効状態:拡縮遷移のEasingです。 |
| DisabledOverrideTexture | DisabledOverrideTexture | bool | 読取・変更 | 追加時の設定を参照 | 無効状態:UI状態専用のTextureを使います。 |
| DisabledTexture | DisabledTexture | Texture? | 読取・変更 | 追加時の設定を参照 | 無効状態:画像Assetの参照です。 |
| DisabledUseAnimationClip | DisabledUseAnimationClip | bool | 読取・変更 | 追加時の設定を参照 | 無効状態:UI状態に専用AnimationClipを使います。 |
| DisabledAnimationClip | DisabledAnimationClip | AnimationClip? | 読取・変更 | 追加時の設定を参照 | 無効状態:UI状態で再生するAnimationClipです。 |
| DisabledSound | DisabledSound | AudioClip? | 読取・変更 | 追加時の設定を参照 | 無効状態:UI状態変化時に再生する音です。 |
| DisabledSoundVolume | DisabledSoundVolume | float | 読取・変更 | 追加時の設定を参照 | 無効状態:UI状態変化の効果音の音量です。 |
Inspectorの設定と使い方
「Editor / C#」は両方から変更できる設定、「Editorのみ」は公開C# APIのない編集操作です。「Editor表示のみ」は計算結果や統計などの確認欄です。「C#のみ」は、このInspectorに編集欄のない操作です。
| 設定・操作 | 編集場所 | C#の入口 | 意味・使い方 |
|---|---|---|---|
| 入力操作対象 | Editor / C# | Interactable | 無効にすると選択・決定の対象から外します。UI全体をGameObjectごと非アクティブにすることとは別です。 |
| 通常・選択・決定・無効のスタイル | Editor / C# | NormalColor / SelectedColor / SubmittedColor / DisabledColor | 各状態で色、スケール、変化時間、Easingを指定します。Normal/Selected/Submitted/Disabledの接頭辞が、C#プロパティの状態を表します。 |
| Texture・音・Animation Clip | Editor / C# | NormalTexture / SelectedTexture / SubmittedTexture / DisabledTexture / SelectedSound / SelectedAnimationClip | Texture上書きの有無、状態移行時の音と音量、色・拡縮補間またはAnimation Clipを選びます。各状態のUseAnimationClipやAnimationEnabledで使用する経路を確認します。 |
| 状態の取得 | C#のみ | State / SelectedThisFrame / SubmittedThisFrame / DisabledThisFrame / NormalThisFrame | 現在の状態や、このframeに移行した状態を読み取れます。状態が続く間の判定と、そのframeだけの通知を混同しないでください。 |
初期値はEngineのComponent定義時の値で、C++表記を含みます。C#へ貼り付ける実行例ではありません。既存Sceneの保存値や既定Assetがある場合はそちらが優先されます。数値の編集範囲はInspectorで制限される場合があります。
C#から使う
操作型はUISelectableです。 GameObjectから取得する基本操作はGameObjectの操作を参照してください。以下には基本プロパティだけでなく、公開関数・追加の設定API・継承した共通操作も掲載します。
選択値(Enum)
| 型・各値の詳説 | 使える値 |
|---|---|
| EasingType | 27件。型のページで全候補を確認できます。 |
| UISelectableState | Disabled / Normal / Selected / Submitted |
UISelectable
| 宣言・詳説 | 種類・操作 | 役割 |
|---|---|---|
public AnimationClip? DisabledAnimationClip | プロパティ(読取・変更) | 無効状態:UI状態で再生するAnimationClipです。 |
public bool DisabledAnimationEnabled | プロパティ(読取・変更) | 無効状態:UI状態遷移のAnimationを有効にします。 |
public Color4 DisabledColor | プロパティ(読取・変更) | 無効状態:色を指定します。RGBAではAlphaも持ちます。 |
public EasingType DisabledColorEasing | プロパティ(読取・変更) | 無効状態:色遷移のEasingです。 |
public float DisabledColorTransitionDuration | プロパティ(読取・変更) | 無効状態:UI状態の色を切り替える秒数です。 |
public bool DisabledOverrideTexture | プロパティ(読取・変更) | 無効状態:UI状態専用のTextureを使います。 |
public Vector2 DisabledScale | プロパティ(読取・変更) | 無効状態:拡縮倍率です。 |
public EasingType DisabledScaleEasing | プロパティ(読取・変更) | 無効状態:拡縮遷移のEasingです。 |
public float DisabledScaleTransitionDuration | プロパティ(読取・変更) | 無効状態:UI状態の拡縮を切り替える秒数です。 |
public AudioClip? DisabledSound | プロパティ(読取・変更) | 無効状態:UI状態変化時に再生する音です。 |
public float DisabledSoundVolume | プロパティ(読取・変更) | 無効状態:UI状態変化の効果音の音量です。 |
public Texture? DisabledTexture | プロパティ(読取・変更) | 無効状態:画像Assetの参照です。 |
public bool DisabledThisFrame | プロパティ(読取専用) | 無効状態へ遷移したフレームか |
public bool DisabledUseAnimationClip | プロパティ(読取・変更) | 無効状態:UI状態に専用AnimationClipを使います。 |
public static UISelectable FromEntity(GameObject gameObject) | 関数 | 既にComponentを持つGameObjectから操作用の参照を作ります。Componentを追加する操作ではありません。 |
public bool Interactable | プロパティ(読取・変更) | UI操作を受け付けます。無効時はDisabledの見た目になります。 |
public AnimationClip? NormalAnimationClip | プロパティ(読取・変更) | 通常状態:UI状態で再生するAnimationClipです。 |
public bool NormalAnimationEnabled | プロパティ(読取・変更) | 通常状態:UI状態遷移のAnimationを有効にします。 |
public Color4 NormalColor | プロパティ(読取・変更) | 通常状態:色を指定します。RGBAではAlphaも持ちます。 |
public EasingType NormalColorEasing | プロパティ(読取・変更) | 通常状態:色遷移のEasingです。 |
public float NormalColorTransitionDuration | プロパティ(読取・変更) | 通常状態:UI状態の色を切り替える秒数です。 |
public bool NormalOverrideTexture | プロパティ(読取・変更) | 通常状態:UI状態専用のTextureを使います。 |
public Vector2 NormalScale | プロパティ(読取・変更) | 通常状態:拡縮倍率です。 |
public EasingType NormalScaleEasing | プロパティ(読取・変更) | 通常状態:拡縮遷移のEasingです。 |
public float NormalScaleTransitionDuration | プロパティ(読取・変更) | 通常状態:UI状態の拡縮を切り替える秒数です。 |
public AudioClip? NormalSound | プロパティ(読取・変更) | 通常状態:UI状態変化時に再生する音です。 |
public float NormalSoundVolume | プロパティ(読取・変更) | 通常状態:UI状態変化の効果音の音量です。 |
public Texture? NormalTexture | プロパティ(読取・変更) | 通常状態:画像Assetの参照です。 |
public bool NormalThisFrame | プロパティ(読取専用) | 通常状態へ遷移したフレームか |
public bool NormalUseAnimationClip | プロパティ(読取・変更) | 通常状態:UI状態に専用AnimationClipを使います。 |
public AnimationClip? SelectedAnimationClip | プロパティ(読取・変更) | 選択状態:UI状態で再生するAnimationClipです。 |
public bool SelectedAnimationEnabled | プロパティ(読取・変更) | 選択状態:UI状態遷移のAnimationを有効にします。 |
public Color4 SelectedColor | プロパティ(読取・変更) | 選択状態:色を指定します。RGBAではAlphaも持ちます。 |
public EasingType SelectedColorEasing | プロパティ(読取・変更) | 選択状態:色遷移のEasingです。 |
public float SelectedColorTransitionDuration | プロパティ(読取・変更) | 選択状態:UI状態の色を切り替える秒数です。 |
public bool SelectedOverrideTexture | プロパティ(読取・変更) | 選択状態:UI状態専用のTextureを使います。 |
public Vector2 SelectedScale | プロパティ(読取・変更) | 選択状態:拡縮倍率です。 |
public EasingType SelectedScaleEasing | プロパティ(読取・変更) | 選択状態:拡縮遷移のEasingです。 |
public float SelectedScaleTransitionDuration | プロパティ(読取・変更) | 選択状態:UI状態の拡縮を切り替える秒数です。 |
public AudioClip? SelectedSound | プロパティ(読取・変更) | 選択状態:UI状態変化時に再生する音です。 |
public float SelectedSoundVolume | プロパティ(読取・変更) | 選択状態:UI状態変化の効果音の音量です。 |
public Texture? SelectedTexture | プロパティ(読取・変更) | 選択状態:画像Assetの参照です。 |
public bool SelectedThisFrame | プロパティ(読取専用) | 選択状態へ遷移したフレームか |
public bool SelectedUseAnimationClip | プロパティ(読取・変更) | 選択状態:UI状態に専用AnimationClipを使います。 |
public UISelectableState State | プロパティ(読取専用) | 現在の選択状態 |
public AnimationClip? SubmittedAnimationClip | プロパティ(読取・変更) | 決定状態:UI状態で再生するAnimationClipです。 |
public bool SubmittedAnimationEnabled | プロパティ(読取・変更) | 決定状態:UI状態遷移のAnimationを有効にします。 |
public Color4 SubmittedColor | プロパティ(読取・変更) | 決定状態:色を指定します。RGBAではAlphaも持ちます。 |
public EasingType SubmittedColorEasing | プロパティ(読取・変更) | 決定状態:色遷移のEasingです。 |
public float SubmittedColorTransitionDuration | プロパティ(読取・変更) | 決定状態:UI状態の色を切り替える秒数です。 |
public bool SubmittedOverrideTexture | プロパティ(読取・変更) | 決定状態:UI状態専用のTextureを使います。 |
public Vector2 SubmittedScale | プロパティ(読取・変更) | 決定状態:拡縮倍率です。 |
public EasingType SubmittedScaleEasing | プロパティ(読取・変更) | 決定状態:拡縮遷移のEasingです。 |
public float SubmittedScaleTransitionDuration | プロパティ(読取・変更) | 決定状態:UI状態の拡縮を切り替える秒数です。 |
public AudioClip? SubmittedSound | プロパティ(読取・変更) | 決定状態:UI状態変化時に再生する音です。 |
public float SubmittedSoundVolume | プロパティ(読取・変更) | 決定状態:UI状態変化の効果音の音量です。 |
public Texture? SubmittedTexture | プロパティ(読取・変更) | 決定状態:画像Assetの参照です。 |
public bool SubmittedThisFrame | プロパティ(読取専用) | 決定状態へ遷移したフレームか |
public bool SubmittedUseAnimationClip | プロパティ(読取・変更) | 決定状態:UI状態に専用AnimationClipを使います。 |
public static int componentTypeID | プロパティ(読取専用) | 組み込みComponentの接続識別子です。通常のゲームコードではGetComponentで取得します。 |
継承する共通操作:Component
継承する共通操作:Object
使用時の注意
Canvasが操作の入口です。親CanvasのPlayerと入力ブロックを確認します。
Play中の変更は実行用Worldへ反映します。Scene編集のUndoと実行中の値の変更は別です。保存方法は編集と実行時変更を参照してください。