Unityチュートリアル: インターフェースと TryGetComponent を使ったアイテムピックアップシステム

2024年11月5日

1. 目標
2. 手順

目標

このチュートリアルの目標は、インターフェースと TryGetComponent を利用して、さまざまなアイテムが共通のピックアップ機能を持ち、プレイヤーがそれらのアイテムに触れると自動で取得できるシステムを作成することです。

手順

ステップ 1: Unityプロジェクトの準備

Unityで新しいプロジェクトを作成します。
「Assets」フォルダで、次のようなフォルダ構造を作成しておきましょう。
- Scripts: スクリプトを保存するためのフォルダ
- Prefabs: アイテムのPrefabを保存するためのフォルダ

ステップ 2: IPickable インターフェースを作成する

「Scripts」フォルダ内で、新しいC#スクリプト IPickable.cs を作成します。
以下のコードを IPickable.cs に追加して、PickUp メソッドを定義します。

// IPickable.cs
public interface IPickable
{
    void PickUp();
}

このインターフェースは、ピックアップ可能なアイテムが必ず実装すべき PickUp メソッドを定義しています。

ステップ 3: アイテムクラスを作成する

次に、アイテムの種類ごとに IPickable を実装したクラスを作成します。ここでは、2つの異なるアイテムを例にして作成します。

HealthItem クラス（ヘルスアイテム）

「Scripts」フォルダ内で、新しいC#スクリプト HealthItem.cs を作成します。
以下のコードを HealthItem.cs に追加します。

using UnityEngine;

public class HealthItem : MonoBehaviour, IPickable
{
    public void PickUp()
    {
        Debug.Log("体力アイテムを拾いました！");
        Destroy(gameObject); // アイテムを消す（拾ったことを示す）
    }
}

AmmoItem クラス（弾薬アイテム）

「Scripts」フォルダ内で、新しいC#スクリプト AmmoItem.cs を作成します。
以下のコードを AmmoItem.cs に追加します。

using UnityEngine;

public class AmmoItem : MonoBehaviour, IPickable
{
    public void PickUp()
    {
        Debug.Log("弾薬アイテムを拾いました！");
        Destroy(gameObject); // アイテムを消す（拾ったことを示す）
    }
}

これで、HealthItem と AmmoItem はどちらも IPickable インターフェースを実装し、それぞれ PickUp メソッドを持つようになりました。

ステップ 4: アイテムのPrefabを作成する

GameObjectを作成: シーン上で新しい Cube オブジェクトを作成し、これをアイテムのモデルとして利用します。
スケールの調整: Cube のサイズを小さく（例えば、0.5 x 0.5 x 0.5）して、アイテムっぽく見えるように調整します。
スクリプトの追加: 作成した Cube に HealthItem または AmmoItem スクリプトをアタッチします。
Prefabとして保存: 調整が終わったら、この Cube を「Prefabs」フォルダにドラッグし、Prefabとして保存します。その後、シーン上から Cube を削除します。
異なるアイテムの作成: Cube を複製し、それぞれに HealthItem と AmmoItem スクリプトをアタッチして、異なるアイテムPrefabを作成します。

ステップ 5: PlayerController スクリプトを作成する

プレイヤーがアイテムに触れたときに IPickable コンポーネントを確認し、PickUp メソッドを呼び出すスクリプトを作成します。

「Scripts」フォルダ内で、新しいC#スクリプト PlayerController.cs を作成します。
以下のコードを PlayerController.cs に追加します。

using UnityEngine;

public class PlayerController : MonoBehaviour
{
    private void OnTriggerEnter(Collider other)
    {
        // 接触したオブジェクトがIPickableインターフェースを持つか確認
        if (other.TryGetComponent<IPickable>(out IPickable item))
        {
            // IPickableを実装しているコンポーネントが存在する場合、PickUpを呼び出す
            item.PickUp();
            Debug.Log("ピックアップ可能なアイテムに接触しました！");
        }
        else
        {
            Debug.Log("このオブジェクトはピックアップできません。");
        }
    }
}

技術資料: Unityの TryGetComponent<t>() メソッド</t>

技術資料: Unityの TryGetComponent() メソッド

概要 TryGetComponent<T>() は、Unityで提供されているメソッドで、特定の型のコンポーネントが ...

https://soft-rime.com/post-20269/

ステップ 6: プレイヤーにColliderを追加する

プレイヤーがアイテムに触れたときに OnTriggerEnter が呼ばれるように、プレイヤーオブジェクトに Collider コンポーネントを追加します。
プレイヤーの Collider を「Is Trigger」に設定し、アイテムに接触しても物理的に影響が出ないようにします。

ステップ 7: 動作確認

アイテムPrefab（HealthItem と AmmoItem）をシーン内に配置します。
プレイヤーをシーン内に配置し、プレイヤーオブジェクトに PlayerController スクリプトをアタッチします。
ゲームを実行し、プレイヤーをアイテムに近づけて、アイテムが取得されることを確認します。

結果

このチュートリアルで作成したシステムでは、プレイヤーがアイテムに触れると、TryGetComponent により IPickable インターフェースを持つかどうかをチェックし、持っている場合は PickUp メソッドが呼ばれ、アイテムが取得されます。

デバッグログの確認

プレイヤーがアイテムに接触すると、「ピックアップ可能なアイテムに接触しました！」というメッセージと、各アイテムに応じた「Health Item picked up!」や「Ammo Item picked up!」といったメッセージが Console に表示されます。

まとめ

このチュートリアルでは、インターフェースと TryGetComponent を活用し、柔軟で拡張性の高いアイテムピックアップシステムを構築しました。このシステムを使うと、将来的に新しいアイテムタイプを追加する場合でも、簡単に IPickable インターフェースを実装するだけで対応できます。

Unity

Posted by hidepon