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

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

１９．シナリオデータを管理するためのGameDataクラスをシングルトンとして作成する
２０．ゲーム進行の管理を行うGameDirectorクラスを作成する
２１．メッセージ表示用のスクリプトを作成する⑥（デバッグデータを、GameDirectorより受け取ったシナリオデータを参照するように修正する）

１９．シナリオデータの管理をするためのGameDataクラスをシングルトンとして作成する

　シナリオデータをUnityに読み込んで管理させるために、GameDataクラスを作成しましょう。
シナリオデータは複数のシーンにおいて使われるであろうことを想定し、GameDataをどのクラスからでも参照できるように
シングルトンパターンというデザインパターンを利用して作成します。

　また処理の一部には、Linq（リンク）という機能を利用しています。これは統合言語クエリと呼ばれる機能の１つで
Listのようなデータの集まりに対して何らかの処理を行うことができる機能です。ここではSelectというメソッドを使っています。
またその際には構文を短くまとめて簡潔に書くことが出来るものです。
　Linqの詳しい使い方については後述しますが、多くの記事がありますので検索して調べてみましょう。

　Scriptsフォルダ内でメニューを表示し、Create => C# Script を選択し、名前をGameDataにします。

　※　Jsonファイルではなく、XLS Import Settingを使ってExcelファイルからスクリプタブル・オブジェクトを作成した場合には、
　　　下段にある別手順でGameDataスクリプトを作成してください。

GameData.cs

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

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using System;
using System.Linq;    // <= Linqを使用する場合には宣言が必要

public class GameData : MonoBehaviour
{
    public static GameData instance;    // 自分自身（GameDataクラス）を代入する変数

    public ScenarioSO scenarioSO;       // スクリプタブル・オブジェクトを代入する変数

    void Awake() {
        // シングルトンにする
        if (instance == null) {
            // instanceの値がnullの場合には、変数に自分自身（GameDataクラス）を入れる
            instance = this;

            // シーン遷移をしても破棄されないメソッドを実行する（対象となるのは引数に指定したもの。ここではGameDataのアタッチされているゲームオブジェクト）
            DontDestroyOnLoad(this.gameObject);
        } else {
            // instanceがnullではない場合にはヒエラルキー上にすでにGameDataクラスが存在しているので、重複するGameDataを破棄する
            Destroy(this.gameObject);
        }
        // ScenarioDataのリストを作成
        CreateScenarioDataList();
    }

    /// <summary>
    /// ScenarioDataのリストを作成
    /// </summary>
    private void CreateScenarioDataList() {
        // スクリプタブル・オブジェクトを初期化
        scenarioSO.scenarioMasterData = new ScenarioMasterData();

        // Jsonファイルを元にSenarioDataを作成して、戻り値を受け取る
        scenarioSO.scenarioMasterData = LoadMasterDataFromJson.LoadScenarioMasterDataFromJson();

        // 文字列を適宜な型に変換して配列に代入
        foreach (ScenarioMasterData.ScenarioData scenarioData in scenarioSO.scenarioMasterData.scenario) {
            // 1行にまとめられているメッセージをカンマの位置で区切って配列に順番に入れる
            scenarioData.messages = scenarioData.messageString.Split(',').ToArray();
　　　　　　
            // 表示するキャラがいる場合
            if (!string.IsNullOrEmpty(senarioData.charaNoString)) {

    　　　　　　// 1行にまとめられているキャラ名をカンマの位置で区切って、Selectを使い、文字列をEnumで用意したキャラの名前に型変換（キャスト）して配列に順番に入れる
                senarioData.charaTypes = senarioData.charaNoString.Split(',').Select(x => (CHARA_NAME_TYPE)Enum.Parse(typeof(CHARA_NAME_TYPE), x)).ToArray();
            }

　　　　　　// 1行にまとめられている分岐の番号をカンマの位置で区切って、Selectを使い、文字列からint型に型変換して配列に入れる
            scenarioData.branchs = scenarioData.branchString.Split(',').Select(x => int.Parse(x)).ToArray();

            // 表示するキャラがいる場合
            if (!string.IsNullOrEmpty(senarioData.displayCharaString)) {

　　            // 1行にまとめられているメッセージ表示に合わせて表示するキャラの名前を半角スラッシュの位置で区切ってリストに入れる
    　　        List<string> strList = scenarioData.displayCharaString.Split('/').ToList();

        　　    int i = 0;

            　　// Dictinaryを初期化
            　　scenarioData.displayCharas = new Dictionary<int, CHARA_NAME_TYPE[]>();

　　　　　　　　// foreachを使いリストの中身を１つずつ取り出してstr変数に代入
            　　foreach (string str in strList) {
　　　　　　　　　　// 1行にまとめらているメッセージ表示に合わせて表示するキャラの名前をカンマで区切って、Selectを使い、文字列をEnumで用意したキャラの名前に型変換（キャスト）して配列に順番に入れる
     　　           CHARA_NAME_TYPE[] displayChara = str.Split(',').Select(x => (CHARA_NAME_TYPE)Enum.Parse(typeof(CHARA_NAME_TYPE), x)).ToArray();

　　　　　　　　　　// Dictinaryに追加
            　　    scenarioData.displayCharas.Add(i, displayChara);
　　                i++;
　　　　　　　　}
            }
        }
        Debug.Log("Create ScenarioDataList");
    }
}

　前回用意したJsonファイルを読み込むメソッド（LoadMasterDataFromJson.LoadScenarioMasterDataFromJson）を
GameDataのCreateScenarioDataListメソッドで呼び出し、ScenerioDataをUnityに登録します。

　ヒエラルキー上でメニューを表示し、Create Emptyを選択して、名前をGameDataに変更します。
これはヒエラルキー上にあればよいので、Canvas内でなくても問題ありません。

　作成したGameDataスクリプトを、このGameDataゲームオブジェクトにアタッチします。ScenarioSOという、スクリプタブル・オブジェクトをアサインできる変数が
インスペクター上に表示されますので、こちらにProject内に用意してあるScenarioSOスクリプタブル・オブジェクトをドラッグアンドドロップでアサインします。

スクリプタブル・オブジェクトをGameDataゲームオブジェクトのGameDataクラスにアサインする方法
https://gyazo.com/71170e7ba7501d07eebdcce20268d699

　実行してみましょう。
　成功すればScenarioDataにJsonで用意したシナリオデータが各項目ごとに自動的に分類されて読み込まれて登録されます。

動画です。
https://gyazo.com/22e854dec7086100c9f0a44997bec29d

　これでExcelで作成したシナリオデータがUnityに登録されて、ゲーム内で利用する準備がすべて整いました。

XLS Import Setting を利用してExcelファイルを元にスクリプタブル・オブジェクトを作成した場合

　　※　XLS Import Setting を利用してスクリプタブル・オブジェクトを作成した場合には、GameDataスクリプトについては、以下のものを利用してください。

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 Scenario scenarioSO;

    void Awake()
    {
        if(instance == null)
        {
            instance = this;

            DontDestroyOnLoad(this.gameObject);
        }
        else
        {
            Destroy(this.gameObject);
        }
        CreateScenarioDataList();
    }

    private void CreateScenarioDataList()
    {       
        foreach (Scenario.Param scenarioData in scenarioSO.sheets[0].list)
        {
            scenarioData.messages = scenarioData.messageString.Split(',').ToArray();

            scenarioData.charaTypes = scenarioData.charaNoString.Split(',').Select(x => (CHARA_NAME_TYPE)Enum.Parse(typeof(CHARA_NAME_TYPE), x)).ToArray();

            scenarioData.branchs = scenarioData.branchString.Split(',').Select(x => int.Parse(x)).ToArray();

            List<string> strList = scenarioData.displayCharaString.Split('/').ToList();

            int i = 0;

            scenarioData.displayCharas = new Dictionary<int, CHARA_NAME_TYPE[]>();

            foreach (string str in strList)
            {
                CHARA_NAME_TYPE[] displayChara = str.Split(',').Select(x => (CHARA_NAME_TYPE)Enum.Parse(typeof(CHARA_NAME_TYPE), x)).ToArray();

                scenarioData.displayCharas.Add(i, displayChara);

                i++;
            }
        }
        Debug.Log("Create ScenarioDataList");
    }
}

２０．ゲーム進行の管理を行うGameDirectorクラスを作成する

　
　ゲーム全体を管理して、ゲームの進行を行うGameDirectorクラスを作成します。
このGameDirectorが次に再生するシナリオの設定や、分岐の管理を行います。

　Scriptsフォルダ内でメニューを表示し、Create => C# Script を選択し、名前をGameDirectorにします。

GameDirector.cs

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

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

public class GameDirector : MonoBehaviour
{  
    public TextMessageViewer textMessageViewer;

    private int currentScenarioNo;

    void Start(){
        // シナリオ番号の初期値をセット
        currentScenarioNo = 0;

        // 最初に再生するシナリオを読み込んでゲームスタート
        ProcScenarioData(currentScenarioNo);
    }

    /// <summary>
    /// 再生するシナリオを準備
    /// </summary>
    private void ProcScenarioData(int nextScenarioNo) {
        // 現在のシナリオ番号を次のシナリオ番号に更新
        currentScenarioNo = nextScenarioNo;

        // currentScenarioNoと合致するシナリオをシナリオデータから検索して、再生するシナリオを決定
        // ① Jsonファイルを使用している場合
        ScenarioMasterData.ScenarioData scenarioData = GameData.instance.scenarioSO.scenarioMasterData.scenario.Find(x => x.scenarioNo == currentScenarioNo);

        // ② XLS Import Settingを使用している場合
        Scenario.Param scenarioData = GameData.instance.scenarioSO.sheets[0].list.Find(x => x.scenarioNo == currentScenarioNo);

        // 文字送りをするクラスにシナリオをセットして、メッセージを再生する(該当するメソッドを次の手順で追加するので、それまでこの処理はコメントアウトしておきます)
        //textMessageViewer.SetUpScenarioData(scenarioData);
    }
}

　GameDirectorでは、現在再生しているシナリオの番号を管理しています。
また、GameDataクラスにアクセスして、次に再生するシナリオデータ（表示するメッセージや分岐の情報など）を取得し、
それをTextMessageViewerクラスに渡す処理を行っています。

　GameDataと同じように、ヒエラルキー上でメニューを表示し、CreateEmptyを選択し、名前をGameDirectorに変更します。
これはヒエラルキー上にあればよいので、作成する場所はCanvas内でなくても問題ありません。

　このGameDirectorゲームオブジェクトにGameDirectorスクリプトをアタッチします。

　インスペクターを確認し、アサイン情報としてTextMessageViewerクラスがアサイン出来るようになっていますので
ヒエラルキー上にあるTextMessageViewerクラスがアタッチされているゲームオブジェクトを選択して、ドラッグアンドドロップでアサインします。

https://gyazo.com/ddbaa99be8432a9c523c2caa3b598a8c

２１．メッセージ表示用のスクリプトを作成する⑥（デバッグ用に表示していたメッセージなどをGameDirectorより受け取ったシナリオデータを参照できるように修正する）

　
　いままでTextMessageViewerクラスでは、仮メッセージとして手動でメッセージなど配列に登録しデバッグを行ってきましたが
ここでやっとシナリオデータがTextMessageViewerに届く準備が整いましたので、TextMessageViewerクラスを修正し、受け取ったシナリオデータを使って
メッセージやキャラの名前を表示するように修正を行っていきます。

TextMessageViewer.cs

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

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

public class TextMessageViewer : MonoBehaviour {

    public string[] messages;                                // 表示するメッセージの配列
    public Text txtMessage;                                  // メッセージ表示用
    public float wordSpeed;                                  // 1文字当たりの表示速度

    public CHARA_NAME_TYPE[] charaTypes;
    public Text txtCharaType;

    public GameObject tapIconObj;

    public int[] branchs;                                    // <= 分岐用の配列を用意（追加☆）

    private int messagesIndex = 0;                           // 表示するメッセージの配列番号
    private int wordCount;                                   // １メッセージ当たりの文字の総数
    private bool isTapped = false;                           // 全文表示後にタップを待つフラグ
    private bool isDisplayedAllMessage = false;              // 全メッセージ表示完了のフラグ

    private IEnumerator waitCoroutine;          　　　　　　　// <= 全文表示までの待機時間メソッド代入用。Stopできるようにしておく
    private Tween tween;                        　　　　　　　// <= DoTween再生用。Killできるように代入して使用する

    void Start() {
        tapIconObj.SetActive(false);

        // Debug用の処理なので、コメントアウト(追加☆)
        //StartCoroutine(DisplayMessage());
    }

///* 以下の処理を追加 *///

    /// <summary>
    /// シナリオのメッセージや分岐などを設定
    /// </summary>
    /// <param name="scenarioData"></param>
    public void SetUpScenarioData(ScenarioMasterData.ScenarioData scenarioData) {        // ☆　<= XLS Import Settingの場合は引数の型を Scenario.Param に変更してください
        Debug.Log("シナリオ番号 : " + scenarioData.scenarioNo  + " のシナリオデータをセット");
  
        // シナリオの各データを準備
        messages = new string[scenarioData.messages.Length];
        messages = scenarioData.messages;

        charaTypes = new CHARA_NAME_TYPE[scenarioData.charaTypes.Length];
        charaTypes = scenarioData.charaTypes;

        branchs = new int[scenarioData.branchs.Length];
        branchs = scenarioData.branchs;

        // 初期化
        messagesIndex = 0;
        isDisplayedAllMessage = false;

        // 1文字ずつメッセージ表示を開始
        StartCoroutine(DisplayMessage());
        Debug.Log("シナリオ 再生開始");
    }

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

    (Updateメソッド以下は変更なしのため省略します)

}

　分岐の番号を代入するための変数branchesを追加し、SetUpScenarioDataメソッドを追加します。
このメソッドを追加しましたら、GameDirectorスクリプトを開いて、コメントアウトしてあった

textMessageViewer.SetUpSenarioData(senarioData);

この処理からコメントアウトを外して実行できるようにします(TextMessageViewerに該当のメソッドを追加したので、これでもうエラーは出ません)

　適宜な地点にDebug.Logを入れておきましたので、処理が順番にちゃんと流れているかをコンソールで確認しましょう。

　正常に処理が動いていれば、シナリオデータの０番のデータの最初のメッセージが再生されます。
メッセージ送りをしたり、表示されるキャラの名前がちゃんとシナリオデータと一致しているかなどを確認します。

https://gyazo.com/10efa1cafc571e86b84c9b0573042e70

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

印刷する

コメント（0）

カテゴリ：
進学/スクール
総合

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

コメントをかく

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

i-school