２ＤタイルマップＲＰＧ　手順２３ - i-school

　GameData クラスにて管理している所持アイテムの情報を追加・削除、加算・減算する制御を実装します。

＜実装画像　所持アイテムの追加・加算＞

動画ファイルへのリンク

＜実装画像　所持アイテムの減算・削除＞

動画ファイルへのリンク

手順２３　－所持しているアイテムの追加・削除機能の追加－

４０．GameData スクリプトを修正して、所持しているアイテムの情報の追加・加算する機能を追加する
４１．GameData スクリプトを修正して、所持しているアイテムの情報の減算・削除する機能を追加する

　新しい学習内容は、以下の通りです。

　・foreach 文による処理の流れを把握する
　・作成したメソッドを自由にデバッグする方法を覚える

４０．GameData スクリプトを修正して、所持しているアイテムの情報の追加・加算する機能を追加する

１．設計

　GameData クラスにて管理している所持アイテムの情報を追加・削除する制御を実装します。
この機能を追加することで、例えば、買い物をしたアイテムを追加したり、宝箱から獲得したアイテムを追加したり、
売却した場合に削除したりといった機能が実装出来るようになります。

　所持しているアイテムの情報は GameData クラスで管理を行っていますので、
アイテムを獲得した際の追加・削除する処理も、おなじ GameData クラス内に追記して実装するような設計にします。

　これは前回のセーブ・ロードと同じ理由です。アイテムの情報を管理しているクラスであるからだけではなく、
GameData クラスがシングルトンクラスであるため、このクラス内にアイテムの追加・削除用のメソッドを実装しておくことにより、
外部のクラスから任意のタイミングでこれらの処理の呼び出し命令を行いやすくするためでもあります。

　アイテムを獲得したり、使用して消費したり、売却したり、という行動はゲーム内では様々な場面で想定されます。
そのため自由にアイテムの追加・削除が実行できる設計の方が利便性が高いと言えるからです。

２．GameData スクリプトを修正する

　実装するメソッドは、アイテムの獲得によるインベントリへの追加処理１つだけです。
それでも一読しただけでは理解が難しいと思いますので、繰り返し読み解いていってください。

　また Update メソッドに、このアイテムを獲得してインベントリに追加する処理の呼び出し命令を実装しておきます。
今回も任意のタイミングでボタンを押してアイテムの獲得処理を行ってみてください。
処理に問題がなければどのスクリプトに記述しても大丈夫でしょう。

GameData.cs

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

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

public class GameData : MonoBehaviour
{
    public static GameData instance;        // シングルトンデザインパターンのクラスにするための変数

    public int randomEncountRate;　　　　　 // エンカウントの発生率

    public bool isEncouting;                // エンカウントしている状態かどうかの判定用。true の場合エンカウントしている状態

    public bool isDebug;                    // デバッグ用の変数。true ならば、エンカウントしている状態をリセットできる

    private Vector3 currentPlayerPos;       // エンカウント時のプレイヤーキャラの位置の情報を保持するための変数

    private Vector2 currentLookDirection;　 // エンカウント時のプレイヤーキャラの方向の情報を保持するための変数


    [System.Serializable]
    public class ItemInventryData {
        public ItemName itemName;    // アイテムの名前
        public int count;            // 所持数
        public int number;           // 所持している通し番号

        /// <summary>
        /// ItemInventryData クラスのコンストラクタ
        /// </summary>
        /// <param name="name">アイテムの名前</param>
        /// <param name="value">アイテムの所持数</param>
        /// <param name="num">アイテムを所持した際の通し番号</param>
        public ItemInventryData(ItemName name, int value, int num) {
            itemName = name;
            count = value;
            number = num;
        }
    }

    [Header("所持アイテムのリスト")]
    public List<ItemInventryData> itemInventryDatasList = new List<ItemInventryData>();


    void Awake() {
        if (instance == null) {
            instance = this;
            DontDestroyOnLoad(gameObject);
        } else {
            Destroy(gameObject);
        }
    }

    /// <summary>
    /// エンカウント時のプレイヤーキャラの位置と方向の情報を保持
    /// </summary>
    /// <param name="encountPlayerPos"></param>
    /// <param name="encountLookDirection"></param>
    public void SetEncountPlayerPosAndDirection(Vector3 encountPlayerPos, Vector2 encountLookDirection) {

　　　　// エンカウント時のプレイヤーキャラの位置と方向の情報が引数で届くので、それらを変数に保持
        currentPlayerPos = encountPlayerPos;
        currentLookDirection = encountLookDirection;

        Debug.Log("プレイヤーのエンカウント位置情報更新");
    }

    /// <summary>
    /// エンカウント時のプレイヤーキャラの位置情報を戻す
    /// </summary>
    /// <returns></returns>
    public Vector3 GetCurrentPlayerPos() {

　　　　// 保持している情報を戻す
        return currentPlayerPos;
    }

    /// <summary>
    /// エンカウント時のプレイヤーキャラの方向を戻す
    /// </summary>
    /// <returns></returns>
    public Vector2 GetCurrentLookDirection() {

　　　　// 保持している情報を戻す
        return currentLookDirection;
    }

    /// <summary>
    /// ItemInvetryDatasList の最大数を取得
    /// </summary>
    /// <returns></returns>
    public int GetItemInventryListCount() {
        return itemInventryDatasList.Count;
    }

    /// <summary>
    /// ItemInvetryDatasList の中から指定した要素番号の ItemInventryData 情報を取得
    /// </summary>
    /// <param name="no"></param>
    /// <returns></returns>
    public ItemInventryData GetItemInventryData(int no) {
        return itemInventryDatasList[no];
    }

　　/// <summary>
    /// 所持アイテムのセーブ
    /// </summary>
    public void SaveItemInventryDatas() {
        for (int i = 0; i < itemInventryDatasList.Count; i++) {
            PlayerPrefs.SetString(itemInventryDatasList[i].itemName.ToString(), itemInventryDatasList[i].itemName.ToString() + "," + itemInventryDatasList[i].count.ToString() + "," + i.ToString());
        }

        PlayerPrefs.Save();

        Debug.Log("ItemInventry セーブ完了");
    }

    /// <summary>
    /// 所持アイテムのロード
    /// </summary>
    public void LoadItemInventryDatas() {

        // アイテムデータ分だけ繰り返す
        for (int i = 0; i < DataBaseManager.instance.GetItemDataSOCount(); i++) {

            // ItemName でセーブしてあるデータが PlayerPrefs 内にあるか
            if (!PlayerPrefs.HasKey(DataBaseManager.instance.GetItemDataFromItemNo(i).itemName.ToString())) {
　　　　　　　　
　　　　　　　　// セーブデータがなければここで処理を終了し、次のセーブデータを確認する処理へ移る
                continue;
            }

            // セーブされているデータを読み込んで配列に代入
            string[] stringArray = PlayerPrefs.GetString(DataBaseManager.instance.GetItemDataFromItemNo(i).itemName.ToString()).Split(',');

            // セーブデータからアイテムのデータをコンストラクタ・メソッドを利用して復元
            itemInventryDatasList.Add(new ItemInventryData((ItemName)Enum.Parse(typeof(ItemName), stringArray[0]), int.Parse(stringArray[1]), int.Parse(stringArray[2])));
        }

        // 以前に所持していた番号順で所持アイテムの並び順をソート
        itemInventryDatasList = itemInventryDatasList.OrderBy(x => x.number).ToList();

        Debug.Log("ItemInventry ロード完了");
    }

　　// デバッグ用
    private void Update() {

　　　　// デバッグ用　セーブ
        if (Input.GetKeyDown(KeyCode.K) && isDebug) {
            SaveItemInventryDatas();
        }

　　　　// デバッグ用　ロード
　　　　if (Input.GetKeyDown(KeyCode.L) && isDebug) {
            LoadItemInventryDatas();
        }


////*  ここから処理を追加  *////


　　　　// デバッグ用　ロード
　　　　if (Input.GetKeyDown(KeyCode.i) && isDebug) {

            // 追加・加算したいアイテムの名前と数を引数に指定してメソッドを呼び出し
            AddItemInventryData(ItemName.ひのきの棒, 1);    // 引数を変更することで追加・加算するアイテムを指定する
        }


////*  ここまで  *////


    }


////*  ここからメソッドを１つ追加  *////


    /// <summary>
    /// ItemInvetryData を追加・加算
    /// </summary>
    /// <param name="itemName"></param>
    /// <param name="amount"></param>
    public void AddItemInventryData(ItemName itemName, int amount = 1) {

        // List の要素を１つずつ確認して、すでに所持しているアイテムか確認
        foreach (ItemInventryData itemInventryData in itemInventryDatasList) {

            // 所持しているアイテムの場合
            if (itemInventryData.itemName == itemName) {

                // 所持数を加算
                itemInventryData.count += amount;

                Debug.Log("リストに対象アイテムを加算 : " + itemName + " / 合計 : " + itemInventryData.count + " 個");

　　　　　　　　// 処理を終了
                return;
            }
        }

        // 所持していないアイテムの場合、新しく所持アイテムとして追加する
        itemInventryDatasList.Add(new ItemInventryData(itemName, amount, itemInventryDatasList.Count));

        Debug.Log("リストに対象アイテムを新規追加 : " + itemName + " / " + amount + " 個");
    }


////*  ここまで  *////


    }
}

　スクリプトを修正したらセーブします。

３．ゲームを実行して動作を確認する

　GameData ゲームオブジェクトのインスペクターより、現在所持しているアイテムの情報である itemInvntryDatasList 変数の Size を 0 にしておきます。
また、isDebug ボタンにチェックを入れてデバッグ用モードに切り替えておきます。

　ゲームを実行して、デバッグ用に用意したボタンを操作してアイテムの獲得によるインベントリへの追加処理を実行してください。
所持していないアイテムの場合には新しく itemInvntryDatasList 変数の Size が増えて、アイテムがインベントリへの追加されます。
すでに所持しているアイテムの場合には、その数が加算されます。

＜実装画像　所持アイテムの追加・加算＞

動画ファイルへのリンク

　以上でアイテムの追加機能は実装完了です。続いて、指定したアイテムの情報をインベントリより除算、および削除する機能を実装します。

４１．GameData スクリプトを修正して、所持しているアイテムの情報の減算・削除する機能を追加する

１．設計

　所持しているアイテムの情報であるインベントリから、指定したアイテムを指定した数だけ除算する処理を実装します。
また、除算の結果、所持数が 0 以下になったアイテムをインベントリより削除する処理も合わせて実装を行います。

　この処理も利用する場所が多岐に渡ると想定されますので、 GameData クラスに実装を行う設計にします。

２．GameData スクリプトを修正する

　実装するメソッドは、指定したアイテムの情報を指定した数だけ除算するメソッド１つだけです。
それでも一読しただけでは理解が難しいと思いますので、繰り返し読み解いていってください。

　また Update メソッドに、この作成したアイテムの除算用のメソッドを呼び出す処理を実装しておきます。
今回も任意のタイミングでボタンを押して処理が正常に動くかを確認します。問題がなければどのスクリプトに記述しても大丈夫でしょう。

GameData.cs

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

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

public class GameData : MonoBehaviour
{
    public static GameData instance;        // シングルトンデザインパターンのクラスにするための変数

    public int randomEncountRate;　　　　　 // エンカウントの発生率

    public bool isEncouting;                // エンカウントしている状態かどうかの判定用。true の場合エンカウントしている状態

    public bool isDebug;                    // デバッグ用の変数。true ならば、エンカウントしている状態をリセットできる

    private Vector3 currentPlayerPos;       // エンカウント時のプレイヤーキャラの位置の情報を保持するための変数

    private Vector2 currentLookDirection;　 // エンカウント時のプレイヤーキャラの方向の情報を保持するための変数


    [System.Serializable]
    public class ItemInventryData {
        public ItemName itemName;    // アイテムの名前
        public int count;            // 所持数
        public int number;           // 所持している通し番号

        /// <summary>
        /// ItemInventryData クラスのコンストラクタ
        /// </summary>
        /// <param name="name">アイテムの名前</param>
        /// <param name="value">アイテムの所持数</param>
        /// <param name="num">アイテムを所持した際の通し番号</param>
        public ItemInventryData(ItemName name, int value, int num) {
            itemName = name;
            count = value;
            number = num;
        }
    }

    [Header("所持アイテムのリスト")]
    public List<ItemInventryData> itemInventryDatasList = new List<ItemInventryData>();


    void Awake() {
        if (instance == null) {
            instance = this;
            DontDestroyOnLoad(gameObject);
        } else {
            Destroy(gameObject);
        }
    }

    /// <summary>
    /// エンカウント時のプレイヤーキャラの位置と方向の情報を保持
    /// </summary>
    /// <param name="encountPlayerPos"></param>
    /// <param name="encountLookDirection"></param>
    public void SetEncountPlayerPosAndDirection(Vector3 encountPlayerPos, Vector2 encountLookDirection) {

　　　　// エンカウント時のプレイヤーキャラの位置と方向の情報が引数で届くので、それらを変数に保持
        currentPlayerPos = encountPlayerPos;
        currentLookDirection = encountLookDirection;

        Debug.Log("プレイヤーのエンカウント位置情報更新");
    }

    /// <summary>
    /// エンカウント時のプレイヤーキャラの位置情報を戻す
    /// </summary>
    /// <returns></returns>
    public Vector3 GetCurrentPlayerPos() {

　　　　// 保持している情報を戻す
        return currentPlayerPos;
    }

    /// <summary>
    /// エンカウント時のプレイヤーキャラの方向を戻す
    /// </summary>
    /// <returns></returns>
    public Vector2 GetCurrentLookDirection() {

　　　　// 保持している情報を戻す
        return currentLookDirection;
    }

    /// <summary>
    /// ItemInvetryDatasList の最大数を取得
    /// </summary>
    /// <returns></returns>
    public int GetItemInventryListCount() {
        return itemInventryDatasList.Count;
    }

    /// <summary>
    /// ItemInvetryDatasList の中から指定した要素番号の ItemInventryData 情報を取得
    /// </summary>
    /// <param name="no"></param>
    /// <returns></returns>
    public ItemInventryData GetItemInventryData(int no) {
        return itemInventryDatasList[no];
    }

　　/// <summary>
    /// 所持アイテムのセーブ
    /// </summary>
    public void SaveItemInventryDatas() {
        for (int i = 0; i < itemInventryDatasList.Count; i++) {
            PlayerPrefs.SetString(itemInventryDatasList[i].itemName.ToString(), itemInventryDatasList[i].itemName.ToString() + "," + itemInventryDatasList[i].count.ToString() + "," + i.ToString());
        }

        PlayerPrefs.Save();

        Debug.Log("ItemInventry セーブ完了");
    }

    /// <summary>
    /// 所持アイテムのロード
    /// </summary>
    public void LoadItemInventryDatas() {

        // アイテムデータ分だけ繰り返す
        for (int i = 0; i < DataBaseManager.instance.GetItemDataSOCount(); i++) {

            // ItemName でセーブしてあるデータが PlayerPrefs 内にあるか
            if (!PlayerPrefs.HasKey(DataBaseManager.instance.GetItemDataFromItemNo(i).itemName.ToString())) {
　　　　　　　　
　　　　　　　　// セーブデータがなければここで処理を終了し、次のセーブデータを確認する処理へ移る
                continue;
            }

            // セーブされているデータを読み込んで配列に代入
            string[] stringArray = PlayerPrefs.GetString(DataBaseManager.instance.GetItemDataFromItemNo(i).itemName.ToString()).Split(',');

            // セーブデータからアイテムのデータをコンストラクタ・メソッドを利用して復元
            itemInventryDatasList.Add(new ItemInventryData((ItemName)Enum.Parse(typeof(ItemName), stringArray[0]), int.Parse(stringArray[1]), int.Parse(stringArray[2])));
        }

        // 以前に所持していた番号順で所持アイテムの並び順をソート
        itemInventryDatasList = itemInventryDatasList.OrderBy(x => x.number).ToList();

        Debug.Log("ItemInventry ロード完了");
    }

　　// デバッグ用
    private void Update() {

　　　　// デバッグ用　セーブ
        if (Input.GetKeyDown(KeyCode.K) && isDebug) {
            SaveItemInventryDatas();
        }

　　　　// デバッグ用　ロード
　　　　if (Input.GetKeyDown(KeyCode.L) && isDebug) {
            LoadItemInventryDatas();
        }

　　　　// デバッグ用　アイテムの追加。所持している場合には加算
　　　　if (Input.GetKeyDown(KeyCode.i) && isDebug) {

            // 追加・加算したいアイテムの名前と数を引数に指定してメソッドを呼び出し
            AddItemInventryData(ItemName.ひのきの棒, 1);    // 引数を変更することで追加・加算するアイテムを指定する
        }


////*  ここから処理を追加  *////


　　　　// デバッグ用　所持しているアイテムの減算
　　　　if (Input.GetKeyDown(KeyCode.o) && isDebug) {

            // 減算したいアイテムの名前と数を引数に指定してメソッドを呼び出し。除算後の所持数が 0 以下になった場合には削除
            RemoveItemInventryData(ItemName.ひのきの棒, 1);    // 引数を変更することで減算するアイテムを指定する
        }


////*  ここまで  *////


    }

    /// <summary>
    /// ItemInvetryData を追加・加算
    /// </summary>
    /// <param name="itemName"></param>
    /// <param name="amount"></param>
    public void AddItemInventryData(ItemName itemName, int amount = 1) {

        // List の要素を１つずつ確認して、すでに所持しているアイテムか確認
        foreach (ItemInventryData itemInventryData in itemInventryDatasList) {

            // 所持しているアイテムの場合
            if (itemInventryData.itemName == itemName) {

                // 所持数を加算
                itemInventryData.count += amount;

                Debug.Log("リストに対象アイテムを加算 : " + itemName + " / 合計 : " + itemInventryData.count + " 個");

　　　　　　　　// 処理を終了
                return;
            }
        }

        // 所持していないアイテムの場合、新しく所持アイテムとして追加する
        itemInventryDatasList.Add(new ItemInventryData(itemName, amount, itemInventryDatasList.Count));

        Debug.Log("リストに対象アイテムを新規追加 : " + itemName + " / " + amount + " 個");
    }


////*  ここからメソッドを１つ追加  *////


    /// <summary>
    /// ItemInventryData を減算。0 以下になったら削除
    /// </summary>
    /// <param name="itemName"></param>
    /// <param name="amount"></param>
    public void RemoveItemInventryData(ItemName itemName, int amount = 1) {

        // List の要素を１つずつ確認して、すでに所持しているアイテムか確認
        foreach (ItemInventryData itemInventryData in itemInventryDatasList) {

            // 所持しているアイテムの場合
            if (itemInventryData.itemName == itemName) {

                // 所持数を減算
                itemInventryData.count -= amount;

                Debug.Log("リストに対象アイテムを減算 : " + itemName + " / 合計 : " + itemInventryData.count + " 個");

                // 所持数が 0 以下になったら
                if (itemInventryData.count <=0) {

                    // 所持アイテムから削除
                    itemInventryDatasList.Remove(itemInventryData);

                    Debug.Log("リストから対象アイテムを削除 : " + itemName);
                }              
                return;
            }
        }

        Debug.Log("リストに対象アイテムなし");
    }


////*  ここまで  *////


}

　スクリプトを修正したらセーブします。

３．ゲームを実行して動作を確認する

　ゲームを実行し、先ほど追加したアイテムをインベントリに追加する処理を実行して、インベントリにアイテムを追加します。
この状態でデバッグ用に用意したボタンを押して、指定されたアイテムの数を除算するメソッドを呼び出します。
アイテムが指定された数だけ除算されていけば制御成功です。また、所持数が 0 以下になった場合にはインベントリより削除されれば制御成功です。

＜実装画像　ロード＞

動画ファイルへのリンク

　処理が成功したら、デバッグ用に記述した加算メソッドと除算メソッドの引数を変更し、他のアイテムが加算されるかも自分でしっかりと確認しておきましょう。
何故ならば、これらの処理を実際に適宜なスクリプト内に記述して、アイテムを入手できるようにしたりする処理を、自分で考えて実装することなるためです。

　今回のアイテムの加算・減算処理、および前回のセーブやロードも同じですが、特定のタイミングで制御を行いたい処理については、
このように Update メソッド内にデバッグ用に割り当てたボタンを用意しておくことにより、任意のタイミングでの処理のデバッグが可能になります。
またこれらの処理はデバッグモード用でのみ操作できるようにしておく(isDebug 変数が true の間だけ有効になる)ことにより、実際のゲームでは操作できないように制御出来ます。

　実際にはゲーム内のイベントなどのタイミングで処理を実行することになりますが、そのイベントを作る前にこれらの処理を作成しておくことにより、
あとは任意のスクリプトに、適宜なタイミングで用意した処理を実行するだけで、アイテムの加算・除算の処理を実装することが出来ます。

　制御したい処理を考えて、それを実装するにはどういった手順で設計して作っていけばよいかを考えてからプログラムを構築していきましょう。

　自分で製作しているゲームですので、手を加える程、愛着がわいてきます。たくさん自分のアレンジを加えて、楽しみながら製作を行ってください。

　以上でこの手順は終了です。

　次は　手順２４　ー探索イベントの実装準備ー　です。