テキストアドベンチャー　手順１４

　以下の内容で実装していきます。

３１．すべてのエンディングをコンプリートすると新しい機能が開放される処理を実装する

　新しく学習する内容です。

　・PlayerPrefsを利用したデータのセーブ・ロード
　・PlayerPrefsの初期化

３１．すべてのエンディングをコンプリートすると新しい機能が開放される処理を実装する

　複数のエンディングがあるゲームにおいて、すべてのエンディングをコンプリートすると新しい機能が開放される処理を追加します。

事前準備

　事前準備としまして、Gameシーン以外のTitleシーンを作成し、Canvas内にボタンを１つ用意しておいてください。
このボタンはActiveスイッチをオフにして、見えない状態(非アクティブ)にしておきます（ヒエラルキー上では灰字で表示）

　またGameDataゲームオブジェクトも必要になります。このゲームオブジェクトはシングルトンですので、複数のシーンに設置してあっても常に1つに制御されます。
GameシーンにあるGameDataゲームオブジェクトをプレファブして、Titleシーンに設置してください。

動画　Activeスイッチをオフにしておく
https://gyazo.com/5c01d86a174b3a6af59f894b759706d4

TitleシーンのヒエラルキーとSceneビューのサンプル画像

　
　今回の機能では、エンディングをコンプリートした状態でゲームを起動すると、非アクティブになっているボタンが自動的にアクティブになる処理になります。
他にも応用できますので、実装方法を考えてみてください。

設計

　次のような設計を行います。

　・エンディングを見る　=>　まだ見たことのないエンディングの場合には、エンディングの番号を保存する
　・ゲーム開始時にエンディングの番号を順番に確認して、コンプリート確認を行う　=>　エンディングをコンプリートしている場合には新しい機能が開放される

　今回の場合は、全エンディングをコンプリートしている場合にはタイトル画面に新しいボタンが追加されるようにします。
そのため、エンディングのコンプリート確認はタイトル画面で行うようにします。

　また1回見たエンディングについてはエンディングの保存対象から外すように制御をします。

実装手順

　以下の手順で実装を行います。

　１．Excelファイルを修正して、エンディング番号を追加する
　２．SenarioMasterDataスクリプトを修正して、エンディングの情報(エンディング番号)を登録できるようにする
　３．GameDataスクリプトを修正して、プレイヤーが見たエンディングの番号をセーブしたり、ロードする機能を追加する
　４．TextMessageViewewスクリプトを修正して、エンディング番号にかかわる処理を追加する
　５．Titleシーン用のTitleスクリプトを作成し、Titleゲームオブジェクトにアタッチする
　６．ゲームを実行して動作を確認する

１．Excelファイルを修正して、エンディング番号を追加する

　Excelファイルの最後に新しい項目として endingNo を追加します。
0の場合はエンディング対象なし、1以上の数字がエンディングの対象となり、その値がそのままエンディングの番号となります。

サンプル Jsonファイル

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

{
  "senario": 
  [
    {
      "senarioNo": "0",
      "messageString": "あいうえお,かきくけこ",
      "charaNoString": "1,2",
      "branchString": "-1",
      "displayCharaString" : "3/0,1",
      "backgroundImageNo" : "0",
      "bgmNo" : "0",
      "branchMessageString" : "123,aaa",
      "autoScenarioNo": "1",
      "endingNo": "0"
    },
    {
      "senarioNo": "1",
      "messageString": "さしすせそ\nなにぬねの,たちつてと",
      "charaNoString": "0,1",
      "branchString": "5/0,1,2",
      "displayCharaString" : "0,2/1",
      "backgroundImageNo" : "1",
      "bgmNo" : "0",
      "branchMessageString" : "fff,ddd,kkk",
      "autoScenarioNo": "0",
      "endingNo": "0"
    },
    {
      "senarioNo": "2",
      "messageString": "わをん",
      "charaNoString": "2,3",
      "branchString": "0",
      "displayCharaString" : "0,1,2",
      "backgroundImageNo" : "2",
      "bgmNo" : "0",
      "branchMessageString" : "gggg",
      "autoScenarioNo": "0",
      "endingNo": "1"
    }
  ]
}

２．SenarioMasterDataスクリプトを修正して、エンディングの情報(エンディング番号)を登録できるようにする

　【１】で作成したExcelデータをゲーム内に読み込めるように、SenarioMasterDataスクリプト(あるいはSenarioスクリプト)を修正し、 endingNo を追加します。

Excel => Jsonからスクリプタブル・オブジェクトを作成している場合

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

using System.Collections.Generic;

[System.Serializable]
public class SenarioMasterData {

    public List<SenarioData> senario = new List<SenarioData>();   // JsonのTitleと合わせること

    [System.Serializable]
    public class SenarioData {
        // Jsonで読み込む
        public int senarioNo;
        public string messageString;
        public string charaNoString;
        public string branchString;
        public string displayCharaString;
        public int backgroundImageNo;
        public int bgmNo;
        public string branchMessageString;
        public int autoScenarioNo;　
　　　　public int endingNo;                // <=  ☆　追加

        // 読み込んだDataを配列に置き換えて代入
        public string[] messages;
        public CHARA_NAME_TYPE[] charaTypes;
        public int[] branchs;
        public Dictionary<int, CHARA_NAME_TYPE[]> displayCharas;
        public string[] branchMessages;
        public List<int> conditionalBranchNo;                  
    }
}

Excel ImporterでExcelファイルから直接スクリプタブル・オブジェクトを作成している場合

Scenario.cs

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

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

public class Scenario : ScriptableObject
{	
    public List<Sheet> sheets = new List<Sheet> ();

    [System.SerializableAttribute]
    public class Sheet
    {
	public string name = string.Empty;
	public List<Param> list = new List<Param>();
    }

    [System.SerializableAttribute]
    public class Param
    {	
	public int senarioNo;
	public string messageString;
	public string charaNoString;
	public string branchString;
	public string displayCharaString;
	public int backgroundImageNo;
	public int bgmNo;
	public string branchMessageString;
	public int autoScenarioNo;
　　　　public int endingNo;                  //  <=  ☆　追加

	public string[] messages;
	public CHARA_NAME_TYPE[] charaTypes;
	public int[] branchs;
	public Dictionary<int, CHARA_NAME_TYPE[]> displayCharas;
	public string[] branchMessages;
        public List<int> conditionalBranchNo;
    }
}

３．GameDataスクリプトを修正して、プレイヤーが見たエンディングの番号をセーブしたり、ロードする機能を追加する

　GameDataスクリプトを修正して、エンディングの総数を登録出来るようにするために、新しく変数を３つ追加します。
合わせて、プレイヤーが見たエンディングの番号をセーブしたり、ロードする処理も追加します。

　エンディングを見た際に、そのエンディングが初めて見たエンディングである場合に限り、SaveEndingDataメソッドでエンディング番号をセーブします。
この制御を追加しておかないと、見たことのあるエンディングを再度見た場合にもセーブされていまい、不具合が発生します。

　見ているエンディングの保存データをロードする際には、LoadCheckEndingDataメソッドを呼び出し、コンプリートしているかどうかの判定も一緒に行うようにします。　

GameData.cs

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

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

public class GameData : MonoBehaviour
{

    // 今までの宣言フィールドは変更なし。以下の３つの変数を宣言フィールドに追加する


////* ここから追加 *////


    public int endingCount;   // 追加。用意しているエンディングの総数

    public List<int> endingNos = new List<int>();   // 追加。実際に確認しているエンディングの数。Debugしてエンディングの登録が確認できたら private 修飾子にしてください

    private string ENDING = "ending_";   // 追加。エンディングの保存用文字列

////* ここまで追加 *////


    void Awake() {
        // 変更なしのため省略
    }

    /// <summary>
    /// SenarioDataのリストを作成
    /// </summary>
    private void CreateScenarioDataList() {
        // 変更なしのため省略
    }


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

    /// <summary>
    /// 見たエンディングの番号を保存
    /// </summary>
    /// <param name="endingNo"></param>
    public void SaveEndingData(int endingNo) {
        PlayerPrefs.SetInt(ENDING + endingNo.ToString(), endingNo);
        PlayerPrefs.Save();
    }    

    /// <summary>
    /// 保存されているエンディングがあるか確認し、すべて見ている場合にはtrueとする
    /// </summary>
    /// <returns></returns>
    public bool LoadCheckEndingData() {
        // 見ているエンディングを確認     
        for (int i = 1; i < endingCount + 1; i++) {
            // エンディングを１つずつ確認
            if (PlayerPrefs.HasKey(ENDING + i.ToString())) {
                // 見ているエンディングだけ読み込み、リストに追加
                endingNos.Add(PlayerPrefs.GetInt(ENDING + i.ToString(), 0));
            }
        }
　　　　// リストのエンディング数とエンディングの総数が一緒ならコンプリート(true)。そうでない場合は未コンプリート(false)として判定
        return endingCount == endingNos.Count ? true : false;
    }

////* ここまで追加 *////

}

＜PlayerPrefsを利用したデータのセーブ・ロード＞

　UnityにはPlayerPrefs(プレイヤー・プリフ、プレイヤー・プリファレンス)という、ゲームデータをセーブ・ロードする機能を持つクラスがあります。

　PlayerPrefsクラスにはゲームデータに関わる複数のメソッドが用意されていますが、今回はint型でセーブを行うSetIntメソッドを利用しています。
合計で４つのメソッドを使っていますので、順番に説明します。

PlayerPrefs.SetInt(string key, int value)

　第1引数で用意した key の名前で value の情報を保存するために設定します。Set～メソッドは3種類あり、今回はint型で値を設定するSetIntメソッドを使用しています。
Set～メソッドは扱う型は異なりますが、構造はすべて同じです。

　private string ENDING = "ending_";

　PlayerPrefs.SetInt(ENDING + endingNo.ToString(), endingNo);

　例えば endingNo = 1 である場合には、

　PlayerPrefs.SetInt("ending_1", 1);

　という処理が行われていることになります。ending_1 という名前で 1 の値をセーブする、という内容です。
処理は変数同士の扱いであるため、内容が分かりにくいですが、このように常に変数の中身がどのようになっているかを考えて処理を読むようにしてください。

PlayerPrefs.Save()

　Saveメソッドを実行することで、Set～メソッドで設定した値を key として保存します。

　Saveメソッドが実行されると、UnityエディターではPC内にセーブされ、Androidなどの端末の場合には、ゲーム内の専用の保存場所にセーブされます。
この処理を実行することでゲームを終了しても、セーブした値を読み込むことが出来るようになります。

　Set～メソッドだけではセーブされませんので、Set～メソッドとSaveメソッドは必ず1セットで使うことを覚えておいてください。

　一度セーブした情報を同じ key で保存した場合には上書きされます。またセーブした情報は自動的には破棄されません。

PlayerPrefs.HasKey (string key)

　HasKeyメソッドを実行すると引数で指定した key が現在セーブされている情報の中に存在しているかどうかを bool型で返してくれます。
セーブデータに key が存在している場合には true、存在していない場合(セーブされていない場合)には false が返ります。

　今回はENDING + i.ToString()を引数に指定していますので、"ending_i" の名前でセーブされているエンディングの番号があるかどうかを確認しています。
そしてセーブされている key があった場合のみ、データのロードを行うようにしています。

　if (PlayerPrefs.HasKey(ENDING + i.ToString())) {

PlayerPrefs.GetInt (string key)　戻り値　int

　データのロードを行うメソッドです。Set～メソッドと対応しているため、Get～メソッドも3種類あります。

　GetIntメソッドでは、key で指定したデータをロードし、戻り値として int の値を返してくれます。
今回は戻り値を endingNos 変数(List<>型)に代入しています。

  // 見ているエンディングだけ読み込み、リストに追加
  endingNos.Add(PlayerPrefs.GetInt(ENDING + i.ToString()));

　なおGet～メソッドは引数にオーバーロードがあります。
第2引数を指定すると、その値を初期値として代入するようになり、その後にロードを行ってデータがある場合には初期値を上書きします。

　セーブデータが存在しない場合には必要な処理になりますが、今回はデータがあることを確認してからロードを行っており、不要な処理であるため省略しています。
　

参考サイト

Unity公式スクリプトリファレンス
PlayerPrefs
https://docs.unity3d.com/ja/current/ScriptReferenc...

　スクリプトの修正が終了したら、GameDataゲームオブジェクトのインスペクターを確認します。
新しく追加した変数のうち、EndingConut 変数には、ゲームにおいて用意しているエンディングの総数を登録します。
まだエンディングの用意がない間は 0 にしておきます。

　LoadCheckEndingDataメソッドでは、このエンディングの総数と、プレイヤーが見ているエンディングの数とを照合して、コンプリート判定を行っています。

４．TextMessageViewerスクリプトを修正し、エンディング番号にかかわる処理を追加する

　複数の箇所で追記を行います。記載のないメソッドは変更なしのため、そのままで問題ありません。

　最初に宣言フィールドに変数を１つ追加し、シナリオデータの持つエンディングの番号を管理出来るようにします。

　SetUpScenarioDataメソッドを修正して、エンディングの番号を登録します。
エンディングの番号は 1 以上で設定されますので、0 の場合にはエンディングを持たないシナリオデータとなります。

　NextTouchメソッドを修正し、エンディングの番号を持つシナリオデータの場合には、エンディングの番号をセーブします。
このとき、すでに見ているエンディングの場合には番号の登録を行わないように制御をします。

　JudgeEndingメソッドを修正して、エンディングの番号が 0 ではない場合にはエンディングになるように制御を追加します。
　

TextMessageViewer.cs

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

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

public class TextMessageViewer : MonoBehaviour {

　　// 今までの宣言フィールドは変更なし。新しく１つの変数を追加

    public int endingNo;    // 宣言フィールドに追加


　　// ここに書いていないメソッドは変更なし。


////* SetUpScenarioDataメソッド内に処理を追加 *////	
	
    public void SetUpScenarioData(SenarioMasterData.SenarioData senarioData) {

　　    // 省略
	    
　　　　autoScenerioNo = senarioData.autoScenarioNo;

　　　　// シナリオデータのエンディング番号が0以外の場合はエンディングがあるため追加
        if (senarioData.endingNo != 0) {        // 追加
            endingNo = senarioData.endingNo;    // 追加
        }                                       // 追加

        // 1文字ずつメッセージ表示を開始
        StartCoroutine(DisplayMessage());
	
	}
 
////* ここまで *////

 
////* NextTouchメソッド内に処理を追加 *////	

    /// <summary>
    /// タップするまで全文を表示したまま待機
    /// </summary>
    /// <returns></returns>
    private IEnumerator NextTouch() {
	
        // 省略

            // エンディングか確認
            if (JudgeEnding()) {
                // エンディングの場合の処理

                // 立ち絵キャラを非表示にする
                for (int i = 0; i < displayCharasList.Count; i++) {
                    displayCharasList[i].gameObject.SetActive(false);
                }

////* ここから追加 *////

                // まだこのエンディングを見ていなければ(エンディングの番号リストになければ)、エンディングの番号を保存　// 追加
                if (GameData.instance.endingNos.Contains(endingNo)) {　　　　　　　　　　　// 追加
                    GameData.instance.SaveEndingData(endingNo);　　　　　　　　　　　　　　　// 追加
                    Debug.Log("Ending SaveNo :" + endingNo);　　　　　　　　　　　　　　　　　// 追加
                }
	
////* ここまで *////
			
            } else {
                if (branchs[0] == -1) {
                   
　　　//　省略



////* JudgeEndingメソッド内に処理を追加 *////	

    private bool JudgeEnding() {
        // エンディングの条件によって分岐

        if (endingNo != 0) {　　　　　　  // 追加
            // Trueならエンディング　　　  // 追加
            return true;　　　　　　　　　  // 追加
        }        

        return false;
    }

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

５．Titleシーン用のTitleスクリプトを作成し、Titleゲームオブジェクトにアタッチする

　Titleシーンにスクリプトを追加します。
　すでにTitleシーン用のスクリプトを用意している場合には、そのスクリプトに、こちらのスクリプトの内容を追記してください。

Title.cs

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.SceneManagement;
using UnityEngine.UI;

public class Title : MonoBehaviour 
{
    public bool isNewGameButton;

    public Button btnNewGame;

    void Start() {
　　　　// エンディングの登録がある場合、すべてのエンディングを見ているか確認。
        if (GameData.instance.endingCount > 0) {
            CheckEndingCount();
        }
    }

    /// <summary>
    /// エンディングを見た数の確認
    /// </summary>
    private void CheckEndingCount(){
        // LoadCheckEndingDataメソッドを実行し、すべてのエンディングを見ている場合には true 見ていない場合には false が戻る
        isNewGameButton = GameData.instance.LoadCheckEndingData();

        // すべてのエンディングを見ている場合
        if (isNewGameButton == true) {
            // 新しいボタンを表示
            btnNewGame.gameObject.SetActive(true);

            // 新しいボタンにメソッドを登録
            btnNewGame.onClick.AddListener(OnClickNewGameButton);
        }
    }

    /// <summary>
    /// Gameシーンへ遷移。ボタンに登録する
    /// </summary>
    public void LoadGameScene() {
        SceneManager.LoadScene("Game");
    }

    /// <summary>
    /// エンディング・コンプリート時に追加されるボタンに登録する処理。スクリプトから登録する
    /// </summary>
    private void OnClickNewGameButton() {
        // TODO 新しいゲーム、エンディングのスタート内容を記述

    }
}

　Titleスクリプトをアタッチするゲームオブジェクトを作成します。ヒエラルキー上で右クリックしてメニューを表示し、CreateEmptyを選択します。
名前を Title に変更します。Titleゲームオブジェクトは、Canvasの中に作成する必要はありません。

　Titleゲームオブジェクトに、Titleスクリプトをアタッチし、インスペクターを確認します。
btnNewGame変数のアサイン情報が表示されますので、Canvas内に作成してある btnNewGame ゲームオブジェクトをドラッグアンドドロップしてアサインしてください。

Titleゲームオブジェクトのインスペクター画像

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

　GameDataゲームオブジェクトを選択してインスペクターにある EndingConut の値を 1 以上にします。
これでTitleスクリプトでのエンディング数のチェックが行われるようになります。

GameDataゲームオブジェクトのインスペクター画像

　ゲームを進めて、シナリオデータで用意したエンディングの番号が 0 以外の分岐を選択し、エンディングの番号が登録されるか、Debug.Logをみて確認を行います。
正常にセーブされたら、ゲームを停止して、再度ゲームを起動します。

　このときに見ているエンディングの数が 1 であれば、EndingConutの値と同じになるので、Titleスクリプトの isNewGame 変数が true になります。
合わせて、Titleシーン内で非アクティブであったボタンが表示されるようになります。

実装動画①　エンディングのデータの読み込みが終わって、NewGameの条件を満たした場合にはチェックが入る(trueになる)
https://gyazo.com/625de186558f6d567bc31a6a1bbf6ba0

実装動画②　NewGameの場合には、新しくボタンが表示される
https://gyazo.com/a8d13582e6a09e5c311e08296457bcba

＜PlayerPrefsの初期化＞

　
　一度UnityからPlayerPrefsを使って保存されたデータは自動的には破棄されません。

　Unityの左上のメニューから　Edit => Clear All PlayerPrefs を選択してください。これで何も保存されていない状態に戻ります。
デバッグを行う場合に活用してください。

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

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

印刷する

コメント（0）

テキストアドベンチャー　手順１４ - i-school 先頭へ

コメントをかく

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

i-school