２Ｄ放置ゲーム　手順２１ - i-school

　獲得した褒賞を記録しているクラスがないため、新しくユーザーのプレイデータを記録するためのクラスを作成し、獲得した褒賞を記録できるようにします。
この機能を実装できると、この値をセーブ・ロードする機能を追加したり、それを元に獲得している褒賞をアルバム表示する機能なども実装出来ます。
　
　具体的には、新しく獲得した褒賞をリストに追加し、すでに獲得している褒賞の場合には数を増やします。
また、褒賞の持つポイント分だけ、ユーザーの合計ポイントの値を加算していく処理を実装します。

＜実装動画　獲得した褒賞を種類ごとに分けてリスト追加し、ポイントを加算＞

動画ファイルへのリンク

手順２１　－ユーザーのプレイデータをゲーム中に記録する機能の実装－

３６．GameData スクリプトを作成する
３７．GameManager スクリプトを修正し、獲得した褒賞のデータを GameData に追加する処理を実装する

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

　・シングルトンデザインパターンによるクラスの活用

３６．GameData スクリプトを作成する

１．設計

　褒賞を獲得する処理は実装できました。しかし、その情報を記録しているクラスがないため、現在は内容的には獲得できていないのと同じ状態になっています。
ユーザーが獲得できた状態にするためには、新しくユーザーのプレイデータを記録するためのクラスを作成し、獲得した褒賞を記録できるようにします。

　全体の設計としては、この機能を実装できると、この値をセーブ・ロードする機能を追加したり、それを元に獲得している褒賞をアルバム表示する機能なども実装出来ます。
それはすべてこの機能の実装が前提となっているためです。言い換えるなら、それらの機能を考えて実装するためには、事前の準備をどのようにするかを考えておく必要があるということにもなります。

　先を見通して、順番に処理を組み立てていくという設計デザインをイメージしてください。
この流れは、OfflineTimeManager クラスを作成して、時間を記録できる状態にしてから、セーブ・ロードを行えるようにし、
その後、お使いのデータを反映させていった、今までの実装手順とほぼ同じ機能実装の流れになります。

　何回も設計とロジックを組み立てていくことによって、実装までの流れが把握できるようになりますので、繰り返し学習を行いましょう。
そして新しく１つの機能を実装できることで、その先の実装にもつながっていくことを理解していきましょう。

　少しずつ機能を作って組み立てていく、という言葉通りの内容になりますので、全体としてどのような機能が欲しいのか、
そのためには何を少しずつ足していけばいいのかを考えていくようにしてください。。
　

　今回の実装では、新しく作成するクラス内に、獲得した褒賞をリスト化して追加していきます。ここが「ユーザーデータを記録する」機能になります。
すでに獲得している褒賞の場合には、同じ褒賞を重複して登録はせずに、獲得数を１ずつ増やして対応します。このロジックを考えることが大切です。
イメージを膨らませて、どのようにすればいいかを書き出してみてください。

　また、褒賞にはポイントがあるため、獲得するたびに、その褒賞の持つポイント分だけ、ユーザーの合計ポイントの値を加算していく処理を実装します。
このポイントをどのように利用するかは任意です。お金のように何かを購入するようにしてもよいですし、経験値のように次のステージに進むための基準値にしてもいいでしょう。

２．GameData スクリプトを作成する

　新しいクラスを作成します。このクラスはシングルトンクラスとして作成します。そうすることで、どのクラスからでもユーザーのデータへのアクセスを容易にする目的があります。

　このクラスには入れ子としてもう１つの別のクラスを作成します。その入れ子クラスが実際にユーザーの褒賞のデータを記録するためのクラスになります。
このシングルトンクラスや、入れ子クラスを利用した設計は、OfflineTimeManager クラスとまったく同じ設計です。そちらも見直してみてください。
そして入れ子クラスを List にして利用しますので、運用方法も同じになります。

　変数には褒賞の獲得ポイントの合計値と、List を用意して、ユーザーの情報を管理する機能を実装します。
メソッドには、獲得した褒賞を List に追加・削除する機能と、獲得したポイントの計算処理を行う機能を、それぞれに役割ごとに分けてメソッド化して準備します。

　ここの準備が整えば、別のクラスから呼び出し命令を受けて、獲得した褒賞を List に登録して記録できるようになります。

GameData.cs

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

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

public class GameData : MonoBehaviour
{
    public static GameData instance;

    /// <summary>
    /// 獲得済の褒賞の登録用クラス
    /// </summary>
    [System.Serializable]
    public class EarnedReward {
        public int rewardNo;      // 褒賞の番号 RewardData の rewardNo と照合する
        public int rewardCount;   // 褒賞の所持数
    }

    [Header("獲得している褒賞のリスト")]
    public List<EarnedReward> earnedRewardsList = new List<EarnedReward>();

    [Header("褒賞ポイントの合計値")]
    public int totalRewardPoint;


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

    /// <summary>
    /// 褒賞ポイント計算
    /// </summary>
    /// <param name="amount"></param>
    public void CalulateTotalRewardPoint(int amount) {
        // 褒賞ポイントを計算して合計値算出
        totalRewardPoint += amount;
    }

    /// <summary>
    /// 獲得した褒賞をリストに追加
    /// すでにリストにある場合には加算
    /// </summary>
    /// <param name="addRewardNo"></param>
    /// <param name="addRewardCount"></param>
    public void AddEarnedRewardsList(int addRewardNo, int addRewardCount = 1) {
        // すでにリストに登録がある褒賞か確認する
        if (earnedRewardsList.Exists(x => x.rewardNo == addRewardNo)) {
            // 登録がある場合には加算
            earnedRewardsList.Find(x => x.rewardNo == addRewardNo).rewardCount++;
        } else {
            // 登録がない場合には新しく追加
            earnedRewardsList.Add(new EarnedReward { rewardNo = addRewardNo, rewardCount = addRewardCount });
        }
    }

    /// <summary>
    /// 獲得している褒賞のリストを削除
    /// 番号指定ありの場合には指定された褒賞の番号の情報を削除
    /// 番号指定なしの場合にはすべて削除
    /// </summary>
    /// <param name="isAll"></param>
    public void RemoveEarnedRewardsList(int rewardNo = 999) {
        if (rewardNo == 999) {
            // すべての褒賞のデータを削除
            earnedRewardsList.Clear();
        } else {
            // 指定された褒賞の番号のデータを削除
            earnedRewardsList.Remove(earnedRewardsList.Find(x => x.rewardNo == rewardNo));
        }
    }
}

　スクリプトを作成したらセーブします。

　実装している処理の多くも、OfflineTimeManager クラスにおいて実装している内容を踏襲しています。
そのため、そちらの処理を参考にしながら復習をして、自分でしっかりと読み解けているかを確認してみてください。

　今回のメソッド内で実装している List を操作する各メソッド(Find メソッド、Exists メソッド、Add メソッド、Clear メソッド、Remove メソッド)については以前にも実装し、説明しています。
また、クラスを new キーワードを使用してインスタンスする処理も学習済です。よい機会ですので、しっかりと復習しておいてください。

３．GameData ゲームオブジェクトを作成し、GameData スクリプトをアタッチして設定を行う

　ヒエラルキーの空いている場所で右クリックをしてメニューを開き、Create Empty を選択します。
これは Canvas ゲームオブジェクト内に表示するゲームオブジェクトではないため、Canvas ゲームオブジェクトの子としては作成しないでください。

　新しく作成されたゲームオブジェクトの名前を GameData に変更します。

　先ほど作成した GameData スクリプトをドラッグアンドドロップしてアタッチしてください。
GameData ゲームオブジェクトのインスペクターを確認し、public 修飾子で宣言している２つの変数が表示されているか確認します。
どちらもゲーム内で値を代入するものなので、現在は確認のみで問題ありません。

インスペクター画像

　以上で設定は完了です。

３７．GameManager スクリプトを修正し、獲得した褒賞のデータを GameData に追加する処理を実装する

１．設計

　今回も TODO 部分を実装して処理を組み立てていきます。先ほど GameData クラスに用意したそれぞれのメソッドを実行する処理を実装していくことになります。
まずは自分で、どの部分に、どの処理を書けば制御が成功するのか、考えて実装してみてください。

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

　TODO に処理を実装していきます。
GameData クラスはシングルトンクラスですので、変数を用意して代入しなくても、直接メソッドへの命令が可能です。

　褒賞を獲得したあとに、褒賞ごとのポイントの加算処理と、褒賞を List に追加する処理を実装することで、ユーザーが褒賞を獲得した状態を作り出します。

GameManager.cs

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

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

public class GameManager : MonoBehaviour
{
    [SerializeField]
    private List<TapPointDetail> tapPointDetailsList = new List<TapPointDetail>();     //  ゲーム内にある行先を束ねて管理するための変数

    [SerializeField]
    private Transform canvasTran;　　　　　　　　　　　　　　　　　　　　　　　　　　　//  行き先確認用ポップアップなどの生成位置の指定の変数。TapPointDetail クラスより移管

    [SerializeField]
    private JobsConfirmPopUp jobsConfirmPopUpPrefab;                                   //  行き先確認ポップアップのプレファブをアサインする変数。TapPointDetail クラスより移管

    [SerializeField]
    private CharaDetail charaDetailsPrefab;                                            //  お使い完了時に生成するキャラのプレファブをアサインする変数。TapPointDetail クラスより移管

    [SerializeField]
    private List<CharaDetail> charaDetailsList = new List<CharaDetail>();              //  お使い完了のキャラを束ねて管理するための変数

    [SerializeField]
    private RewardPopUp rewardPopUpPrefab;　　　　　　　　　　　　　　　　　　　　　　 //　褒賞表示用のポップアップのプレファブをアサインする変数

    [SerializeField]
    private RewardDataSO rewardDataSO;　　　　　　　　　　　　　　　　　　　　　　　　 //　RewardDataSO スクリプタブル・オブジェクトをアサインして参照するための変数

    [SerializeField]
    private JobTypeRewardRatesDataSO JobTypeRewardRatesDataSO;　　　　　　　　　　　　 //　JobTypeRewardRatesDataSO スクリプタブル・オブジェクトをアサインして参照するための変数


    void Start() {

　　　　// TODO 褒賞関連の処理


        // お使いの時間データの確認とロード
　　　　OfflineTimeManager.instance.GetWorkingJobTimeDatasList(tapPointDetailsList);

        // 各 TapPointDetail の設定
        TapPointSetUp();
    }

    /// <summary>
    /// 各 TapPointDetail の設定。お使いの状況に合わせて、仕事中か仕事終了かを判断してキャラを生成するか、お使いを再開するか決定
    /// </summary>
    private void TapPointSetUp() {

　　　　// List に登録されているすべての TapPointDetail クラスに対して１回ずつ処理を行う
        for (int i = 0; i < tapPointDetailsList.Count; i++) {

　　　　　　// TapPointDetail クラスの設定を行う 
            tapPointDetailsList[i].SetUpTapPointDetail(this);

            // 各 TapPointDetail に登録されている JobData に該当する JobTimeData を取得
            OfflineTimeManager.JobTimeData jobTime = OfflineTimeManager.instance.workingJobTimeDatasList.Find((x) => x.jobNo == tapPointDetailsList[i].jobData.jobNo);

            // この行き先がお使い中でなければ次の処理へ移る
            if (jobTime == null) {
                continue;
            }

            // お使いの状態と残り時間を取得
            (bool isJobEnd, int remainingTime) = JudgeJobsEnd(jobTime);

            // ロードした時間とセーブした時間を計算して、まだお使いの時間が経過していない場合には、③を実行する。お使いが完了している場合には①と②を実行する
            if (isJobEnd) {
                // ①お使い完了。お使いのリストとセーブデータを削除　キャラをタップしてから消す
                OfflineTimeManager.instance.RemoveWorkingJobTimeDatasList(jobTime.jobNo);

                // ②キャラ生成して結果を確認
                GenerateCharaDetail(tapPointDetailsList[i]);
            } else {
                // ③お使い未了。行き先の画像をお使い中の画像に変更して、お使い処理を再開。
                JudgeSubmitJob(true, tapPointDetailsList[i], remainingTime);
            }           
        }
    }

    /// <summary>
    /// TapPoint をクリックした際にお使い確認用のポップアップを開く。TapPointDetail クラスより移管
    /// </summary>
    /// <param name="tapPointDetail"></param>
    public void GenerateJobsConfirmPopUp(TapPointDetail tapPointDetail) {

        // お使い確認用のポップアップを作成
        JobsConfirmPopUp jobsConfirmPopUp = Instantiate(jobsConfirmPopUpPrefab, canvasTran, false);

        // ポップアップのメソッドを実行する。メソッドの引数を利用してポップアップに TapPointDetail クラスの情報を送ることで、JobData の情報を活用できるようにする
        jobsConfirmPopUp.OpenPopUp(tapPointDetail, this);
    }

    /// <summary>
    /// お使いを引き受けたか確認
    /// </summary>
    /// <param name="isSubmit"></param>
    public void JudgeSubmitJob(bool isSubmit, TapPointDetail tapPointDetail, int remainingTime = -1) {
        if (isSubmit) {

            // お使いの登録
            OfflineTimeManager.instance.CreateWorkingJobTimeDatasList(tapPointDetail, remainingTime);

            // お使いの準備とお使いの開始
            if (remainingTime == -1) {
                // いままでお使いしていないなら、お使いごとの初期値のお使いの時間を設定
                tapPointDetail.PrapareteJobs(tapPointDetail.jobData.jobTime);
            } else {
                // お使いの途中の場合には、残りのお使いの時間を設定
                tapPointDetail.PrapareteJobs(remainingTime);
            }

            // お使い開始時間のセーブ
            OfflineTimeManager.instance.SaveWorkingJobTimeData(tapPointDetail.jobData.jobNo);

        } else {
            Debug.Log("お使いには行かない");
        }
    }

    /// <summary>
    /// キャラ生成
    /// </summary>
    public void GenerateCharaDetail(TapPointDetail tapPointDetail) {
        tapPointDetail.SwtichActivateTapPoint(false);

        // TODO お使い用のキャラの生成
        Debug.Log("お使い用のキャラの生成");
        CharaDetail chara = Instantiate(charaDetailsPrefab, tapPointDetail.transform, false);

        chara.SetUpCharaDetail(this, tapPointDetail);
    }

　　/// <summary>
    /// 時間の差分より、お使いが終了しているか判定
    /// </summary>
    /// <param name="jobTimeData"></param>
    /// <returns></returns>
    private (bool, int) JudgeJobsEnd(OfflineTimeManager.JobTimeData jobTimeData) {

　　　　// ゲーム起動時の時間とお使いを開始した時間との差分値を算出
        int elaspedTime = OfflineTimeManager.instance.CalculateOfflineDateTimeElasped(jobTimeData.GetDateTime()) * 100;
        Debug.Log("お使い時間の差分 : " + elaspedTime / 100 + " : 秒");

        // 残り時間算出
        int remainingTime = jobTimeData.elaspedJobTime;
        Debug.Log("remainingTime : " + remainingTime);

        // 経過時間がお使いにかかる時間よりも同じか多いなら
        if (remainingTime <= elaspedTime) {
            // お使い完了
            return (true, 0);
        }
        // お使い未了。残り時間から経過時間を減算して残り時間にする
        return (false, remainingTime - elaspedTime);
    }

    /// <summary>
    /// お使いの成果発表
    /// キャラをタップすると呼び出す
    /// </summary>
    public void ResultJobs(TapPointDetail tapPointDetail) {

　　　　Debug.Log("成果 発表");

 　     // お使いの難しさから褒賞決定
        RewardData rewardData = GetLotteryForRewards(tapPointDetail.jobData.jobType);

        Debug.Log("決定した褒賞の通し番号 : " + rewardData.rewardNo);


////*ここから TODO を実装  *////


        // 褒賞ポイントを計算
        GameData.instance.CalulateTotalRewardPoint(rewardData.rewardPoint);

        // 獲得した褒賞を獲得済リストに登録。すでにある場合には所持数を加算
        GameData.instance.AddEarnedRewardsList(rewardData.rewardNo);


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


        // TODO 獲得した褒賞のセーブ


        // TODO 褒賞ポイントのセーブ


        // ③褒賞表示用ポップアップ生成し、RewardPopUp スクリプトのメソッドを実行して、褒賞のデータを引数として渡す
　　　　Instantiate(rewardPopUpPrefab, canvasTran, false).SetUpRewardPopUp(rewardData);

        // お使いのリストとお使いのセーブデータを削除
　　　　OfflineTimeManager.instance.RemoveWorkingJobTimeDatasList(tapPointDetail.jobData.jobNo);
    }

　　/// <summary>
    /// お使いの褒賞の抽選
    /// </summary>
    private RewardData GetLotteryForRewards(JobType jobType) {

        // 難易度による希少度の合計値を算出して、ランダムな値を抽出
        int randomRarityValue = UnityEngine.Random.Range(0, JobTypeRewardRatesDataSO.jobTypeRewardRatesDataList[(int)jobType].rewardRates.Sum());

        Debug.Log("今回のお使いの難易度 : " + jobType + " / 難易度による希少度の合計値 : " + JobTypeRewardRatesDataSO.jobTypeRewardRatesDataList[(int)jobType].rewardRates.Sum());
        Debug.Log("希少度を決定するためのランダムな値 : " + randomRarityValue);

　　　　// 抽選用の初期値を設定
        RarityType rarityType = RarityType.Common;
        int total = 0;

        // 抽出した値がどの希少度になるか確認
        for (int i = 0; i < JobTypeRewardRatesDataSO.jobTypeRewardRatesDataList.Count; i++) {

　　　　　　// 希少度の重み付け行うために加算
            total += JobTypeRewardRatesDataSO.jobTypeRewardRatesDataList[(int)jobType].rewardRates[i];
　　　　　　Debug.Log("希少度を決定するためのランダムな値 : " + randomRarityValue + " <= " + " 希少度の重み付けの合計値 : " + total);

            // total の値がどの希少度に該当するかを順番に確認
            if (randomRarityValue <= total) {
                // 希少度を決定
                rarityType = (RarityType)i;
                break; 
            }
        }

        Debug.Log("今回の希少度 : " + rarityType);

        // 今回対象となる希少度のデータだけのリストを作成
        List<RewardData> rewardDatas = new List<RewardData>(rewardDataSO.rewardDatasList.Where(x => x.rarityType == rarityType).ToList());

        // 同じ希少度の褒賞の提供割合の値の合計値を算出して、ランダムな値を抽出
        int randomRewardValue = UnityEngine.Random.Range(0, rewardDatas.Select(x => x.rarityRate).ToArray().Sum());

        Debug.Log("希少度内の褒賞用のランダムな値 : " + randomRewardValue);

        total = 0;

        // 抽出した値がどの褒賞になるか確認
        for (int i = 0; i < rewardDatas.Count; i++) {

　　　　　　// // total の値が褒賞に該当するまで加算
            total += rewardDatas[i].rarityRate;
            Debug.Log("希少度内の褒賞用のランダムな値 : " + randomRewardValue + " <= " + " 褒賞の重み付けの合計値 : " + total);

            if (randomRewardValue <= total) {

　　　　　　　　// 褒賞確定
                return rewardDatas[i];
            }
        }
        return null;
    }
}

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

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

　GameData ゲームオブジェクトをインスペクターを確認しながら作業を行いましょう。
何故ならば、ここに新しく追加されている２つの変数に対して処理の制御を行っているためです。
常にスクリプトの処理を把握して、どの部分が制御されるのかを確認していくことが大切です。

　処理の流れを見直したら、ゲームを実行してデバッグを行います。お使いを終了して褒賞を獲得してみてください。
GameData ゲームオブジェクトのインスペクターの褒賞のリストにデータが追加されて、その褒賞が持つポイント分が加算されれば制御成功です。

　ゲームを停止せずに、何回も処理を繰り替えてみてください。
ポイントの値がどんどんと加算されていき、リストにも褒賞が追加されていけば制御成功です。

　特に同じ褒賞を獲得した場合、リストには新しく追加されず、すでにある褒賞の数が加算されることを確認してください。
これは同じ褒賞を重複して獲得した際に制御する処理が入っているため、それが正常に動いているかを判断する必要があるからです。

　そのため、リストには褒賞の種類ごとに分けられて追加されていくことになります。

＜実装動画　獲得した褒賞を種類ごとに分けてリスト追加し、ポイントを加算＞

動画ファイルへのリンク

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

　次は　手順２２　ーユーザーのプレイデータをセーブする機能の実装ー　です。