【Unity】Unityにおけるコンポジションとスクリプタブルオブジェクトの活用法

2024年5月14日2024年5月15日

このガイドでは、Unityを使用してコンポジションとスクリプタブルオブジェクトを活用する方法を解説します。PlayerクラスとItemクラスを用いて、データ管理の効率化とコードの再利用性向上を図ります。

【Unity】コンポジションとは

コンポジション（Composition）とは、オブジェクト指向プログラミングにおける設計手法の一つで、複雑 ...

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

1. 元となるコード
- 1.1. デメリット
- 1.2. 改善策
2. 改善策（コンポジションの導入）
3. コンポジションの導入を拡張
4. 改善策（スクリプタブルオブジェクトの導入）
5. スクリプタブルオブジェクトの作成方法（チュートリアル）

元となるコード

このコードは、Unityのゲームオブジェクトにアタッチされたスクリプトが起動時にアイテム名をコンソールに表示するだけのシンプルなコードです。「ゲームの開始時にアイテムの名前をデバッグコンソールに出力する」という動作を行います。

using UnityEngine;

public class Player : MonoBehaviour
{
    string itemName = "Sword";

    void Start()
    {
        Debug.Log(itemName);
    }
}

コンポジションを考慮した場合、以下のコードにはいくつかのデメリットがあります。これらのデメリットを理解することで、より柔軟で拡張性の高い設計が必要な理由を見ていきましょう。

デメリット

柔軟性の欠如:
- このコードでは、アイテムの名前がハードコーディングされています。これにより、アイテムの変更が必要な場合、コードを直接修正しなければなりません。
- 他のアイテムを追加することが困難です。たとえば、プレイヤーが複数のアイテムを持つ場合、現行の設計では対応できません。
再利用性の低さ:
- itemNameはPlayerクラス内で直接管理されているため、他のクラスで同じアイテム名を使用する場合、同じコードを繰り返し書く必要があります。
- アイテムに関する情報（名前、種類、価格など）を一元管理することができず、他のスクリプトでアイテム情報を利用するのが難しいです。
拡張性の制限:
- itemName以外のアイテム属性（例えば、種類、価格、能力など）を追加するのが難しくなります。
- 将来的にアイテムのプロパティを追加・変更する場合、複数のクラスにわたってコードを修正する必要があります。
テストの難易度:
- 単体テストがしづらいです。例えば、アイテム名の変更が必要な場合、コードを変更するために、テストが簡単に壊れる可能性があります。
- アイテムのプロパティが増えると、Playerクラスのテストが複雑化します。
データの分離がない:
- データとロジックが分離されていないため、アイテムのデータを管理する部分と、ゲームロジックを管理する部分が混在しています。
- データが直接コード内に埋め込まれているため、アイテムのデータ管理や更新が困難です。

改善策

これらのデメリットを解消するために、以下のようなアプローチが考えられます：

コンポジションの導入:
- Itemクラスを導入して、アイテムに関する情報を管理し、Playerクラスでそれを利用する。
スクリプタブルオブジェクトの利用:
- アイテム情報をスクリプタブルオブジェクトとして定義し、Unityエディタで簡単に設定・管理できるようにする。

以下に、改善されたコードの例を示します：

改善策（コンポジションの導入）

コンポジション（Composition）とは、通常、クラスが他のクラスのインスタンスをメンバーとして持つことを指します。Unityにおけるコンポジションを使用して、別のクラスにアイテム名を管理させ、それをPlayerクラスに注入する形に変更してみましょう。

Item クラス

まず、アイテムを表現するItemクラスを作成します。

using UnityEngine;

public class Item
{
    public string itemName;

    public Item(string name)
    {
        itemName = name;
    }
}

Player クラス

次に、PlayerクラスがItemクラスのインスタンスを持つようにします。

using UnityEngine;

public class Player : MonoBehaviour
{
    private Item item;

    void Start()
    {
        // Itemクラスのインスタンスを生成し、itemNameを設定
        item = new Item("Sword");
        
        // itemNameを表示
        Debug.Log(item.itemName);
    }
}

このようにすることで、Itemクラスがアイテムに関する情報を管理し、Playerクラスはその情報を使用する形になります。これがコンポジションの基本的な考え方です。

コンポジションのメリット

再利用性の向上: Itemクラスは他のクラスでも使用できます。
関心の分離: Itemクラスがアイテムの情報を管理し、Playerクラスがその情報を使用することで、各クラスの責任が明確になります。
テストの容易さ: ItemクラスとPlayerクラスを個別にテストしやすくなります。

この方法で、より柔軟で拡張性の高いコードを作成することができます。

コンポジションの導入を拡張

Itemクラスにさらにプロパティやメソッドを追加し、複数のアイテムを管理するシナリオを作成することで、コンポジションのメリットをより明確に示します。

Item クラスの改良

using UnityEngine;

public class Item
{
    // アイテムのプロパティ
    public string ItemName { get; private set; }
    public string ItemType { get; private set; }
    public int ItemPrice { get; private set; }

    // コンストラクタでアイテムの情報を設定
    public Item(string name, string type, int price)
    {
        ItemName = name;
        ItemType = type;
        ItemPrice = price;
    }

    // アイテムの情報を表示するメソッド
    public void DisplayInfo()
    {
        Debug.Log($"Item: {ItemName}, Type: {ItemType}, Price: {ItemPrice}");
    }
}

Player クラスの更新

using UnityEngine;

public class Player : MonoBehaviour
{
    private Item[] inventory;

    void Start()
    {
        // 複数のItemインスタンスを生成し、インベントリに追加
        inventory = new Item[]
        {
            new Item("Sword", "Weapon", 150),
            new Item("Shield", "Armor", 100),
            new Item("Health Potion", "Consumable", 50)
        };

        // 全てのアイテムの情報を表示
        foreach (Item item in inventory)
        {
            item.DisplayInfo();
        }
    }
}

コンポジションのメリット

この例を通じて、コンポジションのメリットがより明確になります：

再利用性の向上: Itemクラスは他のクラスでも使用できます。例えば、Shopクラスがアイテムのリストを表示するなど、様々なシナリオで再利用可能です。
関心の分離: Itemクラスがアイテムの情報（名前、種類、価格など）を管理し、Playerクラスはその情報を利用してインベントリを操作します。これにより、各クラスが明確な責任を持つことになります。
テストの容易さ: ItemクラスとPlayerクラスを個別にテストできます。例えば、Itemクラスのテストではアイテムの情報が正しく設定されるかを確認し、Playerクラスのテストではインベントリが正しく管理されるかを確認できます。
拡張性の向上: 新しいアイテムを追加する場合やアイテムのプロパティを変更する場合でも、Itemクラスを修正するだけで済みます。これにより、コードの拡張や変更が容易になります。

このように、コンポジションを使用することで、コードの構造がより明確で柔軟性が高くなり、保守性や拡張性が向上します。

改善策（スクリプタブルオブジェクトの導入）

スクリプタブルオブジェクト（ScriptableObject）を使用することで、データの管理がさらに効率的になります。スクリプタブルオブジェクトは、特にゲーム内のデータを管理するのに便利です。以下は、Itemクラスをスクリプタブルオブジェクトとして実装し、Playerクラスでそれを使用する例です。

Item ScriptableObject クラス

まず、Itemクラスをスクリプタブルオブジェクトとして実装します。

using UnityEngine;

[CreateAssetMenu(fileName = "NewItem", menuName = "Inventory/Item")]
public class Item : ScriptableObject
{
    public string itemName;
    public string itemType;
    public int itemPrice;

    public void DisplayInfo()
    {
        Debug.Log($"Item: {itemName}, Type: {itemType}, Price: {itemPrice}");
    }
}

スクリプタブルオブジェクトの作成

次に、Unityエディタ上でこのスクリプタブルオブジェクトのインスタンスを作成します。以下の手順に従ってください：

Unityエディタでプロジェクトウィンドウを開きます。
任意のフォルダを右クリックして「Create > Inventory > Item」を選択します。
作成されたアイテムを選択し、インスペクターウィンドウで名前、種類、価格を設定します。

Player クラスの更新

最後に、Playerクラスでこれらのスクリプタブルオブジェクトを使用します。

using UnityEngine;

public class Player : MonoBehaviour
{
    // インスペクターから設定するアイテムのリスト
    public Item[] inventory;

    void Start()
    {
        // 全てのアイテムの情報を表示
        foreach (Item item in inventory)
        {
            item.DisplayInfo();
        }
    }
}

このようにコンポジションやスクリプタブルオブジェクトを導入することで、柔軟性、再利用性、拡張性が大幅に向上し、テストやデータ管理も容易になります。

Unityエディタでの設定

Playerスクリプトを持つゲームオブジェクトを選択します。
インスペクターウィンドウでPlayerスクリプトのInventoryフィールドに、先ほど作成したItemスクリプタブルオブジェクトをドラッグ＆ドロップで追加します。

スクリプタブルオブジェクトのメリット

データの分離: データとロジックを分離できます。スクリプタブルオブジェクトはデータを管理し、MonoBehaviourスクリプトはそのデータを利用します。
再利用性: スクリプタブルオブジェクトはプロジェクト内で再利用可能です。複数のプレイヤーやエネミーが同じアイテムデータを参照できます。
インスペクターからの設定: データをインスペクターから直接設定できるため、コードを書かずにデータを変更できます。
メモリ効率: スクリプタブルオブジェクトはシーン間でデータを共有できるため、メモリ使用量を削減できます。

これで、スクリプタブルオブジェクトを使ってアイテムデータを管理する方法がわかります。スクリプタブルオブジェクトを使用することで、データの管理がより簡単で効率的になります。

スクリプタブルオブジェクトの作成方法（チュートリアル）

スクリプタブルオブジェクト（ScriptableObject）は、データの管理や編集を容易にするためにUnityで提供されている非常に便利な機能です。以下では、スクリプタブルオブジェクトの作成、使用、および管理方法について詳しく説明します。

スクリプタブルオブジェクトの作成と設定

Item クラスの作成

まず、Itemクラスをスクリプタブルオブジェクトとして定義します。このクラスは、アイテムのプロパティを保持します。

using UnityEngine;

[CreateAssetMenu(fileName = "NewItem", menuName = "Inventory/Item")]
public class Item : ScriptableObject
{
    public string itemName;
    public string itemType;
    public int itemPrice;

    public void DisplayInfo()
    {
        Debug.Log($"Item: {itemName}, Type: {itemType}, Price: {itemPrice}");
    }
}

CreateAssetMenu属性により、Unityエディタ内でスクリプタブルオブジェクトを簡単に作成できるメニュー項目が追加されます。

スクリプタブルオブジェクトのインスタンスを作成

Unityエディタで以下の手順を実行します：

プロジェクトウィンドウで右クリックし、「Create > Inventory > Item」を選択します。
作成されたItemオブジェクトを選択し、インスペクターウィンドウでアイテムの名前、種類、価格を設定します。

複数のアイテムを作成

必要に応じて複数のItemオブジェクトを作成し、それぞれに適切なプロパティを設定します。

名前	種類	価格
Sword	Weapon	150
Shield	Armor	100
Health Potion	Potion	50

Player クラスでのスクリプタブルオブジェクトの使用

Player クラスの設定

次に、Playerクラスでスクリプタブルオブジェクトを使用します。Playerクラスは、インスペクターからスクリプタブルオブジェクトのインスタンスを受け取ります。

using UnityEngine;

public class Player : MonoBehaviour
{
    public Item[] inventory;

    void Start()
    {
        foreach (Item item in inventory)
        {
            item.DisplayInfo();
        }
    }
}