３Ｄレールガンシューティング　発展２４

　最後のセーブ・ロードの手順になります。

　ただし、すでにセーブ・ロードが必要な情報に関しての機能自体は完成していますので、この手順では前回の手順と合わせて、さらにワンランク上の応用処理の実装を目標としています 。
よって スクリプトを見直してリファクタリングする内容 になります。そのため、難しい処理が多く出てきますので、いますぐに実装を行わなくても問題ありません 。

発展２４ーセーブ・ロード機能の実装④ー

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

　・ローカル関数

１．設計

　先ほどの手順で作成した PlayerPrefsHelper クラスを活用し、セーブ用の情報を１つのクラスとして管理し、
それを JsonUtility クラスを活用してセーブとロードを行う処理にリファクタリングを行います。

　GameData クラス内に入れ子クラスとして、セーブしたい情報をまとめるためのクラスを作成し、セーブする前に new してクラスのインスタンスを作成します。
(入れ子クラスではなく、１つのクラスとして作成しても構いません)
その際に、クリアポイント、クリアしたステージの情報、所持している武器の情報などの、セーブしておきたい情報をクラス内に設定し、それを一括でセーブする対象とします。

　ロードも同様で、セーブしておきたい情報のクラスとしてロードを行い、その後、クラス内にあるクリアポイントなどの値を各変数に代入して設定します。

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

　既存のセーブ・ロード関連の処理をコメントアウトして、新しい処理に書き替えます。
修正箇所や追加する箇所、新しい処理が多いので、ゆっくりと、処理の内容を理解しながら進めましょう。

GameData.cs

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

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

public class GameData : MonoBehaviour {

    public static GameData instance;

    [Header("所持している武器の登録用リスト")]
    public List<WeaponData> weaponDatasList = new List<WeaponData>();

    public int chooseStageNo;

    public List<int> clearStageNoList = new List<int>();

    public int totalClearPoint;


    ////*  新しいクラスと変数の宣言を１つずつ追加  *////


    //private const string CLEAR_POINT_KEY = "clearPoint";               //  そのままでもいいですが、別の方法でセーブを行うため、コメントアウトして構いません。
    //private const string CLEAR_STAGE_NO_KEY = "clearStageNoList";      //  そのままでもいいですが、別の方法でセーブを行うため、コメントアウトして構いません。


    /// <summary>
    /// セーブ・ロード用のクラス
    /// </summary>
    [System.Serializable]
    public class SaveData {
        public int clearPoint;
        public List<int> stageNoList = new List<int>();
        public List<WeaponData> weaponList = new List<WeaponData>();
    }

    private const string SAVE_KEY = "SaveData";        // SaveData クラス用の Key


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


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

        // Debug 用
        //SaveClearPoint();
        //LoadClearPoint();


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


        //ユーザーデータの初期化(呼び出し命令のすぐ下に、呼び出されているローカル関数があるので、処理が追いやすい)
        Initialize();

        // ユーザーデータの初期化用のローカル関数
        void Initialize() {

            // SaveData がセーブされているか確認
            if (PlayerPrefsHelper.ExistsData(SAVE_KEY)) {
                // セーブされている場合のみロード
                GetSaveData();

            } else {
                // セーブされていなければ初期値設定
                totalClearPoint = 0;

                if (!clearStageNoList.Contains(0)) {
                    clearStageNoList.Add(0);
                }

                if (!weaponDatasList.Contains(0)) {
                    weaponDatasList.Add(0);
                }
            }
        }


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


    }

    /// <summary>
    /// 武器データの登録
    /// </summary>
    /// <param name="weaponData"></param>
    public void AddWeaponData(WeaponData weaponData) {
        weaponDatasList.Add(weaponData);

        Debug.Log("武器追加 : " + weaponData.weaponName);
    }

    /// <summary>
    /// クリアしたステージの番号を追加
    /// </summary>
    /// <param name="stageNo"></param>
    public void AddClearStageNoList(int stageNo) {

        // クリアしたステージの番号がまだリストにない場合
        if (!clearStageNoList.Contains(stageNo)) {
            // List に追加
            clearStageNoList.Add(stageNo);

            // TODO セーブ

        }
    }


    ////*　いままで利用していた４つ(リファクタリングしている場合は６つ)のメソッドは利用しなくなります。
    そのまま残しておいて構いませんが、 宣言フィールドの Key 用の変数をコメントアウトしている場合には、メソッドもコメントアウトしてください*////


    /// <summary>
    /// TotalClearPoint の値をセーブ
    /// </summary>
    public void SaveClearPoint() {

        // セーブするための準備・セット
        PlayerPrefs.SetInt(CLEAR_POINT_KEY, totalClearPoint);

        // セーブ実行
        PlayerPrefs.Save();

        Debug.Log("セーブ : " + CLEAR_POINT_KEY + " : " + totalClearPoint);
    }

    /// <summary>
    /// TotalClearPoint の値をロード
    /// </summary>
    public void LoadClearPoint() {

        // Key を利用してロードを行い、戻り値を代入
        totalClearPoint = PlayerPrefs.GetInt(CLEAR_POINT_KEY, 0);

        Debug.Log("ロード : " + CLEAR_POINT_KEY + " : " + totalClearPoint);
    }

    /// <summary>
    /// clearStageNoList の値をセーブ
    /// </summary>
    public void SaveClearStageNoList() {

        // 新しく作成する文字列
        string clearStageNoListString = "";

        // 契約したキャラの List をカンマ区切りの１行の文字列にする
        for (int i = 0; i < clearStageNoList.Count; i++) {
            clearStageNoListString += clearStageNoList[i].ToString() + ",";
        }

        // 文字列をセットしてセーブ
        PlayerPrefs.SetString(CLEAR_STAGE_NO_KEY, clearStageNoListString);
        PlayerPrefs.Save();
    }

    /// <summary>
    /// clearStageNoList の値をロード
    /// </summary>
    public void LoadClearStageNoList() {

        // 文字列としてロード
        string clearStageNoListString = PlayerPrefs.GetString(CLEAR_STAGE_NO_KEY, "");

        // ロードした文字列がある場合
        if (!string.IsNullOrEmpty(clearStageNoListString)) {

            // カンマの位置で区切って、文字列の配列を作成。その際、最後にできる空白の文字列を削除
            string[] strArray = clearStageNoListString.Split(new string[] { "," }, StringSplitOptions.RemoveEmptyEntries);

            Debug.Log(strArray.Length);

            // 配列の数だけ契約したキャラの情報があるので
            for (int i = 0; i < strArray.Length; i++) {
                Debug.Log(strArray[i]);

                // 配列の文字列の値を int 型に変換して List に追加して、契約キャラの List を復元
                clearStageNoList.Add(int.Parse(strArray[i]));
            }
        }
    }


    ////*  ここまでコメントアウト可能です  *////


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


    /// <summary>
    /// セーブする値を SaveData に設定してセーブ
    /// セーブするタイミングは、ステージクリア時、キャラ契約時
    /// </summary>
    public void SetSaveData() {

        // セーブ用のデータを作成
        SaveData saveData = new SaveData {

            // 各値を SaveData クラスの変数に設定
            clearPoint = totalClearPoint,
            stageNoList = clearStageNoList,
            weaponList = weaponDatasList
        };

        // SaveData クラスとして SAVE_KEY の名前でセーブ
        PlayerPrefsHelper.SaveSetObjectData(SAVE_KEY, saveData);
    }

    /// <summary>
    /// SaveData をロードして、各値に設定
    /// </summary>
    public void GetSaveData() {

        // SaveData としてロード
        SaveData saveData = PlayerPrefsHelper.LoadGetObjectData<SaveData>(SAVE_KEY);

        // 各値に SaveData 内の値を設定
        totalClearPoint = saveData.clearPoint;

        clearStageNoList = saveData.stageNoList;

        weaponDatasList = saveData.weaponList;
    }


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


}

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

３．＜ローカル関数＞

　メソッド内には、修飾子を持たないメソッドを入れ子として宣言(作成)することができます。
このような 入れ子になっているプライベートなメソッドをローカル関数 といいます。

＜参考サイト＞

MicroSoft
ローカル関数(C# プログラミングガイド)
https://docs.microsoft.com/ja-jp/dotnet/csharp/pro...

　ローカル関数は、入れ子として宣言しているメソッド(親メソッド)内でのみ、呼び出しの命令が可能です。

　利用する主なケースとしては、クラス内での呼び出し命令が１つであるメソッド(１箇所からしか呼び出し命令がないメソッド)がローカル関数として宣言するメソッドの対象となります。
また、ローカル関数は処理を隠蔽することにもなりますので、通常のメソッドよりも内部的な処理を記述することができ、スコープが短くなることで、エラーの特定が早い段階で判断できるようになります。

　今回は、Initialize メソッドを Awake メソッド内に宣言して作成しています。
つまり、Awake メソッドが親メソッド、Initialize メソッドが入れ子メソッドです。
そのため、この Initialize メソッドは、Awake メソッド内からのみ、呼び出し命令を行うことができます。

　本来 Initialize メソッドは、普通のメソッドのように記述できますが、すべての処理を書いてから精査した際、
呼び出し命令が Awake メソッドからしかないため、ローカル関数として宣言しています。

　ローカル関数は、呼び出し命令と、関数を宣言している場所が同じメソッド内にあるため、
より処理をコンパクトにまとめて、スコープを狭くすることで、見やすく、管理しやすいメソッドとして機能しています。

＜ローカル関数＞

void Awake() {

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

    //ユーザーデータの初期化(呼び出し命令のすぐ下に、呼び出されているローカル関数があるので、処理が追いやすい)
    Initialize();

    // ユーザーデータの初期化用のローカル関数
    void Initialize() {

        // SaveData がセーブされているか確認
        if (PlayerPrefsHelper.ExistsData(SAVE_KEY)) {
            // セーブされている場合のみロード
            GetSaveData();

        } else {
            // セーブされていなければ初期値設定
            totalClearPoint = 0;

            if (!clearStageNoList.Contains(0)) {
                clearStageNoList.Add(0);
            }

            if (!weaponDatasList.Contains(0)) {
                weaponDatasList.Add(0);
            }
        }
    }
}

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

　セーブ・ロード処理のリファクタリングが終了しましたので、ゲームを実行して、セーブ・ロードを行ってみてください。
いままでと同じようにセーブ・ロードが行われていれば、リファクタリングは成功です。
　

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

　次は　発展２５　ー照準器機能の追加－　です。

このページを編集するこのページを元に新規ページを作成

印刷する

コメント（0）

３Ｄレールガンシューティング　発展２４ - i-school 先頭へ

コメントをかく

名前	ユーザIDを使用しないで書き込む	ユーザーIDを使う	ログインする
画像コード	画像に記載されている文字を下のフォームに入力してください。
備考	「http://」を含む投稿は禁止されています。
本文
利用規約をご確認のうえご記入下さい

i-school