UI オブジェクトからフォーカスが外れないようにする
検証環境
- Windows
-
- Windows 11
- Unity エディター
-
- 2020.3.25f1
この Tips の前提設定
この Tips の説明の前提として以下の設定を事前に行っています。
この Tips で参考にしたもの
元ネタがどこかにあったのですがキーワードで検索しても見つかりませんでした。
フォーカスについて
Unity UI オブジェクトは一般的なアプリと同様に入力対象としてアクティブであることを示すフォーカスを持つことができます。 しかし、オブジェクト以外をクリックしたりタッチしたりするとフォーカスをもつオブジェクトが消失してしまい、 キーボードやゲームパッドなどでの操作を受け付けなくなってしまう場合があります。
ここではフォーカスを疑似的に失わないようにスクリプトを使用して制御する方法について説明します。 この対応は Unity としてもつ機能ではないので一瞬フォーカスを失ってしまう可能性があることには注意してください。
オブジェクトの配置
フォーカス制御においてオブジェクトの種類は関係ないので適当に配置してください。
フォーカスされていることが分かりやすいように色を付けています。
とりあえずこの状態で実行するとオブジェクトがフォーカスを受け取った後に何もないところをクリックするとフォーカスがなくなってしまうことが確認できます。
フォーカスがなくならないように制御する
これを行うにはスクリプトを作成します。スクリプト名はなんでもいいですが FocusRequired としておきます。
コードを以下のように入力します。
using System.Collections;
using System.Linq; // 追加
using UnityEngine;
using UnityEngine.EventSystems; // 追加
using UnityEngine.UI; // 追加
public class FocusRequired : MonoBehaviour
{
<summary>
<see cref="Selectable"/> をフックするクラスです。
</summary>
private class SelectionHooker : MonoBehaviour, IDeselectHandler
{
<summary>親コンポーネント。</summary>
public FocusRequired Restrictor;
<summary>
選択解除時にそれまで選択されていたオブジェクトを覚えておく。
</summary>
<param name="eventData"></param>
public void OnDeselect(BaseEventData eventData)
{
Restrictor.PreviousSelection = eventData.selectedObject;
}
}
<summary>選択させないオブジェクト一覧。</summary>
[SerializeField] private GameObject[] NotSelectables;
<summary>直前まで選択されていたオブジェクト。</summary>
private GameObject PreviousSelection = null;
<summary>
選択対象のオブジェクト一覧。
</summary>
private GameObject[] _selectables;
private void Awake()
{
// すべての Selectable を取得する
var selectableList = (FindObjectsOfType(typeof(Selectable)) as Selectable[]).ToList();
// 選択除外がある場合は外す
if (NotSelectables != null)
{
foreach (var item in NotSelectables)
{
var sel = item?.GetComponent<Selectable>();
if (sel != null) selectableList.Remove(sel);
}
}
_selectables = selectableList.Select(x => x.gameObject).ToArray();
// フォーカス許可オブジェクトに SelectionHooker をアタッチ
foreach (var selectable in this._selectables)
{
var hooker = selectable.AddComponent<SelectionHooker>();
hooker.Restrictor = this;
}
// フォーカス制御用コルーチンをスタート
StartCoroutine(RestrictSelection());
}
<summary>
フォーカス制御処理。
</summary>
<returns></returns>
private IEnumerator RestrictSelection()
{
while (true)
{
// 別なオブジェクトを選択するまで待機
yield return new WaitUntil(
() => (EventSystem.current != null) && (EventSystem.current.currentSelectedGameObject != PreviousSelection));
// まだオブジェクトを未選択、または許可リストを選択しているなら何もしない
if ((PreviousSelection == null) || _selectables.Contains(EventSystem.current.currentSelectedGameObject))
{
continue;
}
// 選択しているものがなくなった、または許可していない Selectable を選択した場合は前の選択に戻す
EventSystem.current.SetSelectedGameObject(PreviousSelection);
}
}
}
あまり細かく説明はしませんが、 やってることは現在の選択オブジェクトを保持しておき「選択オブジェクトがなくなった」または「選択させたくないオブジェクトを選択した」場合は前の選択に戻すという処理をしています。
このコンポーネントは存在しているオブジェクトならどこに付けてもいいので EventSystem に付けておきます。
プロパティとして選択させたくないオブジェクトを指定できるようにしているので、試しに選択させたくないボタンを配置してみます。
Not Selectables にボタンをセットしておきます。
実行して動作を確認してみてください。まずは何らかのオブジェクトをクリックして選択した後、何もないところをクリックしてもフォーカスが外れないようになります。
また、選択対象外に設定したボタンをクリックしてもフォーカスが移動されないことを確認できます。