【Unity】UIと画面クリック判定を区別、UIの処理無効にする

本記事を読むと以下の実行ができます

UI上でクリックしても、同時に画面クリックを判定しない。

「Input.GetMouseButton」は、マウスクリックを行うと処理が行われるメソッドです。
例えば、マウスを左クリックすると、変数iの値を増加させる（インクリメント）。
このような処理を行うには、次のようにプログラムします。

if (Input.GetMouseButtonDown(0))
{
    i++;
}

一方で、UIボタンを押すと、変数iの値を減少させる（デクリメント）には、メソッドを使用します。

public void downScore()
{
    i--;
}

UIボタンは左クリックするので、２つのプログラムは同時に処理されてしまい、
変数iの値を増加・減少が同時に起こってしまいます。

「Input.GetMouseButtonDown()」は画面押下で、会話文を進めるときに使用して、
UIボタンは、メニュー画面を選択で使用するように、２つとも使用されることはよくあります。

【Unity】マウス操作をゲームに導入する画面クリックで処理

UnityでCSVのテキストをマウスクリックで１つずつ進めるには、if文でメソッド「Input.GetMouseButtonDown(0)」を使用します。ノベルゲームは画面のクリック回数に応じてテキストを表示するシステムに近づきます。

alicia-ing.com

2024.10.24

本記事では、画面とUIボタンのクリック判定を別々にするコードを紹介します。

EventSystem.current.IsPointerOverGameObject()

「EventSystem.current.IsPointerOverGameObject()」は、ゲーム内のUI（ユーザーインターフェース）にポインタ（マウスやタッチ）が重なっているかどうかを確認します。

UIボタンと画面クリックの見極めは、UIとマウスポイントが重なっていると、処理を実行しないようにします。

要するに、UI上をクリックしていると、処理をキャンセルするコードです。
ポインタ・タッチはスマホやタブレットでタッチスクリーンを使う場合はコードが少し異なります。

本メソッドを使うには、名前空間に「using UnityEngine.EventSystems;」を追加しなければエラーが発生するので、注意してください。

「EventSystem.current.IsPointerOverGameObject()」は「EventSystem.current」と「IsPointerOverGameObject()」に分けることができます。

if (EventSystem.current.IsPointerOverGameObject())  return;    //マウス入力

スマホ向けのゲームの場合はマウス入力では正常に処理されません。
UI上の入力しても画面クリックが判定されてしまうので、コードの加筆修正が必要です。

if(EventSystem.current.IsPointerOverGameObject(Input.GetTouch(0).fingerId))　　//スマホ入力

処理の一例

ここで、「EventSystem.current.IsPointerOverGameObject()」を使った簡単な処理を紹介します。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.EventSystems;

public class NewBehaviourScript : MonoBehaviour
{
    void Update()
    {
        // マウスカーソルがUI上にあるか確認します。
        if (EventSystem.current.IsPointerOverGameObject())
        {
            Debug.Log("The mouse cursor is over a UI element.");
        }
    }
}

マウスカーソルがUI上にある場合はconsoleウィンドウで処理が実行されます。

画面上に、UIテキストとUIボタンを追加して、スクリプトをアタッチして、再生ボタンを押します。

UIボタンを押しても画面が反応せずに、処理を実行する

「EventSystem.current.IsPointerOverGameObject()」を使用して、
目標であるUIボタンをクリックしても画面クリックが反応しない処理をします。

ソースコード

using TMPro;
using UnityEngine;
using UnityEngine.EventSystems;　　　//追加（UI上の動作稼働）

public class count : MonoBehaviour
{
    public TextMeshProUGUI countText; // UIテキストオブジェクト
    int i = 0; // カウンターの初期値

    void Start()
    {

        UpdateCountText();
    }

    void Update()
    {
        //ボタンを押したときは画面クリック無効
        if (EventSystem.current.IsPointerOverGameObject()) return;

        if (Input.GetMouseButtonDown(0)) // マウスの左ボタンが押された場合
        {
            i++; // iをインクリメント
            UpdateCountText();
        }
    }

    // UIボタンが押されたときに呼び出される関数
    public void DecrementCount()
    {
        i--; // iをデクリメント
        UpdateCountText();
    }


    // カウントを表示するテキストを更新する関数
    void UpdateCountText()
    {
        countText.text = i.ToString();
        Debug.Log("Count:" + i);
    }
}

UdemyでUnityを学習

Udemyは、オンデマンド式の学習講座です。
趣味から実務まで使えるおすすめの講座を紹介します。

【Unity】学習ロードマップ｜自作ゲームを作りたい人必見！

Unityを使って自作ゲームを作りたい方必見。ゲームエンジン選択から学習方法、収益化の手段まで初心者向けにわかりやすく解説します。

alicia-ing.com

2024.11.04

解説

・名前空間

「using TMPro」は、TextMeshProUGUIクラスを使用するために必要な名前空間です。
TextMeshProUGUIは、UIテキストを操作する際に必要なクラスが含まれています。

【Unity】TextMeshPro-日本語表示とスクリプト制御

UnityのTextMeshProは日本語のテキストを美しく表示し、スクリプトでテキストを動的に変更することも可能です。改行は"\n"でします。"japanese_full.txt"ファイルを読み込んでTextMeshProに適用します。

alicia-ing.com

2024.11.03

• フィールド（メンバ変数）

「countText」：UI上でカウントを表示するテキストオブジェクトを参照するための変数です。
この変数は、TextMeshProUGUI型であり、UI上のテキストを更新する際に使用されます。
「i」：カウンターの値を保持するための変数です。
ユーザーのアクションによりカウントの値が変化します。

• Startメソッド

UpdateCountTextメソッドが呼び出され、初期状態でUI上にカウントが表示されます。

• Updateメソッド

UI上のボタンがクリックされたかどうかを確認し、クリックされた場合はカウンターをインクリメントし、UpdateCountTextメソッドを呼び出してUI上の表示を更新します。
UI上のボタンがクリックされていない場合は、画面上でのクリックを無効にします。

• DecrementCountメソッド

UI上のボタンが押されたときに呼び出される公開されたメソッドです。
カウンターの値をデクリメントし、UpdateCountTextメソッドを呼び出してUI上の表示を更新します。

• UpdateCountTextメソッド

UI上のテキストを更新するためのメソッドです。
現在のカウンターの値を文字列に変換し、UIテキストオブジェクトのtextプロパティに代入します。
また、デバッグログも出力され、カウンターの値が更新されたことが確認できます。

【Unity】スコアのカウントアップ、クリックされた回数を表示

Unityでボタンを押すと回数がカウントアップし、押した数をスコアとして増加していくシンプルなカウンタープログラムです。ユーザーがボタンや画面のクリックした回数や全体のカウントを表示し、簡単に進捗を追跡できる機能を実装します。

alicia-ing.com

2024.09.26

実演

Hierarchyウィンドウにスクリプトをアタッチして、数値を示すテキストを追加します。
また、UIボタンのOnClickにDecrementCount()メソッドを付加します。

再生ボタンを押すと、冒頭のように画面クリックができるようになります。

まとめ

今回は、ボタンクリックで画面クリック判定しない方法を紹介しました。

UI上の処理をTrueにするには「EventSystem.current.IsPointerOverGameObject()」を使います。ただし、名前空間に「using UnityEngine.EventSystems;」を入れないとエラーが発生するので、注意が必要です。

スマホやタブレットでのゲームを開発する場合は、「EventSystem.current.IsPointerOverGameObject(Input.GetTouch(0).fingerId)」とする必要があります。