技術資料: Unityにおける所持アイテム管理システムのリファクタリング

2024年10月10日

本資料では、Unityを用いたゲーム開発においてプレイヤーが所持するアイテムを管理するシステム (OwnedItemsData クラス) のリファクタリングについて解説します。特に、コード入力時に発生しやすいエラー（IntelliSenseの未定義エラー）を回避し、スムーズにコーディングを進められるような設計に改良します。

1. 元のコードの概要
2. リファクタリングの目的とポイント
- 2.1. 目的
- 2.2. 主なリファクタリングポイント
3. リファクタリング後のコード
4. リファクタリングの詳細解説
5. 使用方法の例
- 5.1. 説明
6. エディタでのエラー回避方法
7. 注意点とベストプラクティス
8. まとめ
9. 参考資料

元のコードの概要

元のコードは、プレイヤーが所有するアイテムの種類と数量を管理するシステムです。主な機能として以下があります：

アイテムの追加 (Add メソッド)
アイテムの使用 (Use メソッド)
データの保存と読み込み (Save メソッドと Instance プロパティ)
所有アイテムの一覧取得 (OwnedItems プロパティ)

using System;
using System.Linq;
using System.Collections.Generic;
using UnityEngine;

[Serializable]
public class OwnedItemsData
{
    // ... (元のコード全体)
}

このシステムはシングルトンパターンを採用しており、OwnedItemsData.Instance を通じて一つのインスタンスを共有します。

リファクタリングの目的とポイント

目的

エラー回避: クラスやメソッドが未定義の状態で使用されることによるIntelliSenseのエラーを防ぐ。
コードの可読性向上: 変数名やメソッド名を分かりやすく変更し、コメントを充実させる。
保守性の向上: クラスの依存関係を整理し、将来的な拡張や修正を容易にする。

主なリファクタリングポイント

クラスの順序変更: OwnedItem クラスを OwnedItemsData クラスの前に定義する。
メソッド名の明確化: Add を AddItem、Use を UseItem に変更。
変数名の統一: number を quantity に変更。
エラーハンドリングの改善: 例外の種類を具体的に (InvalidOperationException)。
コメントの充実: 各クラス、メソッド、プロパティに詳細な説明を追加。

リファクタリング後のコード

以下にリファクタリング後のコードを示します。OwnedItem クラスを OwnedItemsData クラスの前に配置し、変数名やメソッド名を分かりやすく変更しています。

using System;
using System.Linq;
using System.Collections.Generic;
using UnityEngine;

/// <summary>
/// アイテムの所持数管理用モデル
/// </summary>
[Serializable]
public class OwnedItem
{
    /// <summary>
    /// アイテムの種類を取得するプロパティ
    /// </summary>
    public Item.ItemType Type => type;

    /// <summary>
    /// アイテムの所持数量を取得するプロパティ
    /// </summary>
    public int Quantity => quantity;

    /// <summary>
    /// アイテムの種類
    /// </summary>
    [SerializeField]
    private Item.ItemType type;

    /// <summary>
    /// アイテムの所持数量
    /// </summary>
    [SerializeField]
    private int quantity;

    /// <summary>
    /// コンストラクタ
    /// </summary>
    /// <param name="type">アイテムの種類</param>
    public OwnedItem(Item.ItemType type)
    {
        this.type = type;
        this.quantity = 0;
    }

    /// <summary>
    /// アイテムの数量を増やすメソッド
    /// </summary>
    /// <param name="amount">増加させる数量</param>
    public void IncreaseQuantity(int amount = 1)
    {
        quantity += amount;
    }

    /// <summary>
    /// アイテムの数量を減らすメソッド
    /// </summary>
    /// <param name="amount">減少させる数量</param>
    public void DecreaseQuantity(int amount = 1)
    {
        quantity -= amount;
        if (quantity < 0)
        {
            quantity = 0;
        }
    }
}

/// <summary>
/// プレイヤーが所有しているアイテムのデータを管理するクラス
/// </summary>
[Serializable]
public class OwnedItemsData
{
    /// <summary>
    /// PlayerPrefsに保存する際のキー
    /// </summary>
    private const string PlayerPrefsKey = "OWNED_ITEMS_DATA";

    /// <summary>
    /// シングルトンインスタンスを保持する静的変数
    /// </summary>
    private static OwnedItemsData _instance;

    /// <summary>
    /// シングルトンインスタンスを取得するプロパティ
    /// </summary>
    public static OwnedItemsData Instance
    {
        get
        {
            if (_instance == null)
            {
                // PlayerPrefsにデータが存在する場合は読み込む
                if (PlayerPrefs.HasKey(PlayerPrefsKey))
                {
                    string json = PlayerPrefs.GetString(PlayerPrefsKey);
                    _instance = JsonUtility.FromJson<OwnedItemsData>(json);
                }
                else
                {
                    // データが存在しない場合は新しいインスタンスを作成
                    _instance = new OwnedItemsData();
                }
            }
            return _instance;
        }
    }

    /// <summary>
    /// 所持しているアイテムのリスト
    /// </summary>
    [SerializeField]
    private List<OwnedItem> ownedItems = new List<OwnedItem>();

    /// <summary>
    /// 所持アイテムを配列として取得するプロパティ
    /// </summary>
    public OwnedItem[] OwnedItems => ownedItems.ToArray();

    /// <summary>
    /// コンストラクタ
    /// 外部からインスタンス化できないようにするためにprivateに設定
    /// </summary>
    private OwnedItemsData()
    {
    }

    /// <summary>
    /// データをJSON形式でPlayerPrefsに保存するメソッド
    /// </summary>
    public void Save()
    {
        string json = JsonUtility.ToJson(this);
        PlayerPrefs.SetString(PlayerPrefsKey, json);
        PlayerPrefs.Save();
    }

    /// <summary>
    /// アイテムを所持リストに追加するメソッド
    /// </summary>
    /// <param name="type">追加するアイテムの種類</param>
    /// <param name="quantity">追加する数量（デフォルトは1）</param>
    public void AddItem(Item.ItemType type, int quantity = 1)
    {
        OwnedItem item = GetOwnedItem(type);
        if (item == null)
        {
            // 所持リストにアイテムが存在しない場合は新しく追加
            item = new OwnedItem(type);
            ownedItems.Add(item);
        }

        // アイテムの数量を増やす
        item.IncreaseQuantity(quantity);
    }

    /// <summary>
    /// アイテムを消費するメソッド
    /// </summary>
    /// <param name="type">消費するアイテムの種類</param>
    /// <param name="quantity">消費する数量（デフォルトは1）</param>
    /// <exception cref="InvalidOperationException">アイテムが不足している場合にスローされる</exception>
    public void UseItem(Item.ItemType type, int quantity = 1)
    {
        OwnedItem item = GetOwnedItem(type);
        if (item == null || item.Quantity < quantity)
        {
            throw new InvalidOperationException("アイテムが足りません");
        }

        // アイテムの数量を減らす
        item.DecreaseQuantity(quantity);
    }

    /// <summary>
    /// 指定した種類のアイテムを取得するメソッド
    /// </summary>
    /// <param name="type">取得したいアイテムの種類</param>
    /// <returns>指定した種類のOwnedItemオブジェクト。存在しない場合はnull。</returns>
    public OwnedItem GetOwnedItem(Item.ItemType type)
    {
        return ownedItems.FirstOrDefault(item => item.Type == type);
    }
}

リファクタリングの詳細解説

1. クラスの順序を変更

OwnedItem クラスを OwnedItemsData クラスの前に定義することで、OwnedItemsData 内で OwnedItem を使用する際に未定義エラーが発生しないようにしました。これにより、コードを一行ずつ入力（写経）する際のエラーを防ぎます。

2. メソッド名と変数名の明確化

Add メソッドを AddItem に変更し、メソッドの機能を明確化。
Use メソッドを UseItem に変更。
number 変数を quantity に変更し、意味を明確に。

3. エラーハンドリングの改善

UseItem メソッドでアイテムが不足している場合に InvalidOperationException をスローするように変更しました。これにより、例外の種類が具体的になり、エラーハンドリングがしやすくなります。

4. コメントの充実

各クラス、メソッド、プロパティに詳細なコメントを追加し、役割や動作を説明しました。これにより、コードの理解がしやすくなります。

使用方法の例

以下は、このリファクタリング後のクラスを使用してアイテムを追加・使用する例です。

using UnityEngine;

public class GameManager : MonoBehaviour
{
    void Start()
    {
        // アイテムを追加
        OwnedItemsData.Instance.AddItem(Item.ItemType.Potion, 5);
        OwnedItemsData.Instance.AddItem(Item.ItemType.Sword);

        // アイテムを使用
        try
        {
            OwnedItemsData.Instance.UseItem(Item.ItemType.Potion, 2);
        }
        catch (InvalidOperationException ex)
        {
            Debug.LogError(ex.Message);
        }

        // データを保存
        OwnedItemsData.Instance.Save();
    }

    void OnApplicationQuit()
    {
        // ゲーム終了時にデータを保存
        OwnedItemsData.Instance.Save();
    }
}

説明

アイテムの追加
- AddItem メソッドを使用して、ポーションを5つ、剣を1つ追加しています。
アイテムの使用
- UseItem メソッドを使用して、ポーションを2つ消費しています。
- アイテムが不足している場合は例外がスローされ、エラーメッセージがログに出力されます。
データの保存
- Save メソッドを呼び出して、現在のアイテムデータを PlayerPrefs に保存しています。
- ゲーム終了時にも同様にデータを保存します。