アイテム取得処理の実装例 - i-school

　特定のボタンを押した際にアイテムを取得する機能の実装例です。

　アイテムに触れたら自動的にアイテムを取得するタイプの実装方法ではありません。

設計

　特定のボタンを押した際に、コライダーを持つ見えないゲームオブジェクトをプレイヤーの周囲に展開し、
そのコライダーの範囲内にあるゲームオブジェクトを精査して、アイテムであった場合には取得するという機能です。

　具体的なアイテムの効果などは含みませんので、その部分については別途、実装をおこなってください。

　アイテムの判定方法について、ここでは複数のアプローチを提示します。
取得時の機能(コライダーの展開部分)は、すべて同じ機能を利用しています。

　なお記事自体は３Ｄ用ですが、２Ｄでも応用可能です。

１．タグによる判定方法

　もっとも一般的で、実装が容易な方法です。

　<=　クリックすると開きます。

using UnityEngine;

public class ItemCollector : MonoBehaviour
{
    [SerializeField] private int itemsToCollect = 5; // アイテムの取得目標数
    [SerializeField] private float radius = 1.0f;    // アイテムの取得範囲の半径値
    
    private int collectedItems = 0;                  // 現在取得したアイテムの数
    private string itemTag = "Item";                 // 検出したいタグの名前の指定


    void Update()
    {
        // 任意のキーを設定します。ここでは C を利用しています
        if (Input.GetKeyDown(KeyCode.C)) 
        {
            // アイテムの取得有無判定
            TryCollectItem();
        }
    }
    
    /// <summary>
    /// アイテムの取得有無判定
    /// </summary>
    private void TryCollectItem()
    {
        // キャラクターを中心に、radius を半径とした球体形のコライダーを作成し、その範囲内にあるすべてのコライダーを検出して配列にする
        Collider[] hitColliders = Physics.OverlapSphere(transform.position, radius); 

　　　　// アイテムが見つからない場合には、早期リターンしてここで処理を停止する
        if (hitColliders.Length == 0) return;

        // 配列内の要素を１つずつ取り出す
        foreach (Collider collider in hitColliders) {
            
            // "Item" タグを持つオブジェクトであるか判定。それをアイテムとして認識
            if (!collider.gameObject.CompareTag(itemTag)) {
                
                // "Item" ではない場合には、次のループ処理にうつる
                continue;
            }
            
            // ここに到達できるということは、アイテムである確認が取れている

            // アイテムの取得数加算
            collectedItems++;

            // TODO 各アイテムごとの処理。そのためには、GetComponent メソッドが必要

            // アイテムの破棄
            Destroy(collider.gameObject);

            // アイテムの取得数が目標値を超えたら
            if (collectedItems >= itemsToCollect) {
                // ログの表示
                Debug.Log("Clear!");
            }

            // 1フレーム内で複数のアイテムが取得されないようにする
            // まとめて取りたい場合には、この部分は不要
            break;

        }
    }
}

　事前にタグを作成し、検出される側(アイテム側)にタグを設定しておく必要があります。
また、タグによる判定は文字列であるため、大文字小文字の区別がありますので、間違えないように作成してください。

　構文内では、if 文によるネスト(入れ子構造)を深くならないように、continue をしています。

　条件が成立したら、という形で処理を作るだけではなく、条件が成立しなかったら、という形で処理を作ることが出来ます。

＜Physics.OverlapSphere メソッド＞

　Unity の Physics クラスに用意されているメソッドの１つです。球体形のコライダーを一時的に生成し、他のコライダーとの侵入判定を行うことができます。
判定結果として、Collider 配列型の戻り値を持ちます。

　他にも .OverlapBox メソッド、OverlapCapsule メソッドがあり、それぞれに形状が違います。戻り値はいずれも Collider 配列型で同じです。

// キャラクターを中心に、radius を半径とした円形のコライダーを作成し、その範囲内にあるすべてのコライダーを検出して配列にする
Collider[] hitColliders = Physics.OverlapSphere(transform.position, radius);

　OverlapSphere メソッドを実行すると、第1引数の位置を始点に、第2引数の値を半径とした円形のコライダーを展開します。
このとき、このコライダーの範囲内にある、別のゲームオブジェクトのコライダーを検出し、それらをまとめて配列に入れて戻り値として提供します。

　そのため今回のように、コライダー配列型の変数を用意しておくことで代入し、以降の処理で利用していくことが出来ます。

　このメソッドには OverlapSphereNonAlloc メソッドも用意されており、こちらの方がガベージを生成しない分優れていますが、事前に配列の長さを指定しなければなりません。
利用方法を理解できてきたら、リファクタリングして処理の置き換えにチャレンジしてみるとよいでしょう。

参考サイト

Unity 公式スクリプト・リファレンス
Physics.OverlapSphere

Unity 公式スクリプト・リファレンス
Physics.OverlapSphereNonAlloc

　２Ｄ用も用意されてます。
メソッド名は OverlapSphere ではなく、OverlapCircle メソッドと OverlapCircleNonAlloc メソッドです。

参考サイト

Unity 公式スクリプト・リファレンス
Physics2D.OverlapCircle

Unity 公式スクリプト・リファレンス
Physics2D.OverlapCircleNonAlloc

２．レイヤーによる判定

　先ほど利用している Physics.OverlapSphere メソッドの引数には第3引数と第4引数があり、こちらには初期値が代入されています。
そのため、第2引数まで指定すれば利用できるようになっています。

　第3引数にはレイヤーの指定ができるため、その場合、Physics.OverlapSphere メソッドを実行すると、メソッドの範囲内にある、指定したレイヤーのみを配列として取得出来ます。
そのため、if 文による判定を省略できます。

　<=　クリックすると開きます。

using UnityEngine;

public class ItemCollector : MonoBehaviour
{
    [SerializeField] private int itemsToCollect = 5; // アイテムの取得目標数
    [SerializeField] private float radius = 1.0f;    // アイテムの取得範囲の半径値
    [SerializeField] private LayerMask targetLayer;  // 判定したいレイヤー(インスペクターで指定する)
    
    private int collectedItems = 0;                  // 現在取得したアイテムの数


    void Update()
    {
        // 任意のキーを設定します。ここでは C を利用しています
        if (Input.GetKeyDown(KeyCode.C)) 
        {
            // アイテムの取得有無判定
            TryCollectItem();
        }
    }
    
    /// <summary>
    /// アイテムの取得有無判定
    /// </summary>
    private void TryCollectItem()
    {
        // キャラクターを中心に、radius を半径とした球体形のコライダーを作成し、その範囲内にある、指定したレイヤーを持つ、すべてのコライダーを検出して配列にする
        Collider[] hitColliders = Physics.OverlapSphere(transform.position, radius, targetLayer); 

        // アイテムが見つからない場合には、早期リターンしてここで処理を停止する
        if (hitColliders.Length == 0) return;

        // 配列内の要素を１つずつ取り出す。この要素はすべて指定したレイヤーのものだけになっている
        foreach (Collider collider in hitColliders) {
            
            // アイテムの取得数加算
            collectedItems++;

            // TODO 各アイテムごとの処理。そのためには、GetComponent メソッドが必要

            // アイテムの破棄
            Destroy(collider.gameObject);

            // アイテムの取得数が目標値を超えたら
            if (collectedItems >= itemsToCollect) {
                // ログの表示
                Debug.Log("Clear!");
            }

            // 1フレーム内で複数のアイテムが取得されないようにする
            // まとめて取りたい場合には、この部分は不要
            break;

        }
    }
}

　事前にレイヤーを作成し、インスペクターで検出したいレイヤーを指定します。
また、検出される側(アイテム側)にレイヤーを設定しておく必要があります。

　利点としては、Physics.OverlapSphere メソッドで検出されるコライダーをふるいにかけて、指定したレイヤーの情報のみで戻り値を作成できることです。
そのため、配列の中身はすべて指定したレイヤーのコライダーのみであることが保証されるため、タグとは異なり、if 文による判定が不要になっています。

３．クラスによる判定方法

　前述のレイヤーをベースに、処理の実用的にして効率化をおこなった構文です。

　<=　クリックすると開きます。

using UnityEngine;

public class ItemCollector : MonoBehaviour
{
    [SerializeField] private int itemsToCollect = 5; // アイテムの取得目標数
    [SerializeField] private float radius = 1.0f;    // アイテムの取得範囲の半径値
    [SerializeField] private LayerMask targetLayer;  // 判定したいレイヤー(インスペクターで指定する)

    private int collectedItems = 0;                  // 現在取得したアイテムの数


    void Update()
    {
        // 任意のキーを設定します。ここでは C を利用しています
        if (Input.GetKeyDown(KeyCode.C)) 
        {
            // アイテムの取得有無判定
            TryCollectItem();
        }
    }
    
    /// <summary>
    /// アイテムの取得有無判定
    /// </summary>
    private void TryCollectItem()
    {
        // キャラクターを中心に、radius を半径とした円形のコライダーを作成し、その範囲内にある、指定したレイヤーを持つ、すべてのコライダーを検出して配列にする
        Collider[] hitColliders = Physics.OverlapSphere(transform.position, radius, targetLayer); 

        // アイテムが見つからない場合には、早期リターンしてここで処理を停止する
        if (hitColliders.Length == 0) return;

        // 配列内の要素を１つずつ取り出す。この要素はすべて指定したレイヤーのものだけになっている
        foreach (Collider collider in hitColliders) {
                        
            // ItemBase クラスがアタッチされているオブジェクトであるか判定。それをアイテムとして認識
            if (collider.TryGetComponent(out ItemBase item)) {
                
            　　// アイテムの取得数加算
            　　collectedItems++;

            　　// TODO 各アイテムごとの処理。ここで item 変数が利用できるので、GetComponent が不要

            　　// アイテムの破棄
                Destroy(item.gameObject);

                // アイテムの取得数が目標値を超えたら
                if (collectedItems >= itemsToCollect) {
                    // ログの表示
                    Debug.Log("Clear!");
                }

                // 1フレーム内で複数のアイテムが取得されないようにする
                // まとめて取りたい場合には、この部分は不要
                break;
            }
        }
    }
}

　アイテム処理の抽象化をベースに、ItemBase クラスを取得できるかを確認しています。
タグやレイヤーでの判定の場合、アイテムの効果を利用するタイミングで別途、アイテムのクラスの取得(GetComponent メソッド)が必要になりますが
こちらのアプローチであればすでにクラスを取得しているので GetComponent メソッドが不要です。(すぐに命令が出せます。)

　できる限り、タグやレイヤーでの判定ではなく、クラスでの判定を行うようにします。
そしてレイヤーについては、活用できる部分では上手く組み合わせていきましょう。

＜発展形＞イベント駆動型による実装例

　UniRx の機能を利用して、ボタンの判定をイベント駆動型にリファクタリングしたものです。
アイテムの判定方法は【３．クラスによる判定方法】を採用しています。

　<=　クリックすると開きます。

using System;
using UniRx;
using UnityEngine;

public class ItemCollector : MonoBehaviour
{
    [SerializeField] private int itemsToCollect = 5;
    [SerializeField] private float radius = 1.0f;
    [SerializeField] private LayerMask targetLayer;

    private int collectedItems = 0;


    void Start() {

　　　　// キーが押されたときにアイテムを収集するための購読処理
        this.UpdateAsObservable()
            .Where(_ => Input.GetKeyDown(KeyCode.C))
            .Subscribe(_ => TryCollectItem());
    }

    /// <summary>
    /// アイテムの取得有無判定
    /// </summary>
    private void TryCollectItem()
    {
        Collider[] hitColliders = Physics.OverlapSphere(transform.position, radius, targetLayer);

        if (hitColliders.Length == 0) return;

        foreach (Collider collider in hitColliders)
        {
            if (collider.TryGetComponent(out ItemBase item))
            {
                collectedItems++;

                // TODO: 各アイテムごとの処理

                Destroy(item.gameObject);

                if (collectedItems >= itemsToCollect)
                {
                    Debug.Log("Clear!");
                }

                break;
            }
        }
    }
}

　Update メソッド内で処理していたボタンの押下確認処理を Start メソッド内でのボタンの購読処理にリファクタリングしています。

まとめ

　このようにアイテムの判定方法だけでも複数のアプローチがあります。
色々な方法を実装し、学習しておくことでスキルの幅が広がります。