３Ｄレールガンシューティング　手順１７ - i-school

　ゲームの進行状況を管理するための機能を実装します。

手順１７ーゲームの進行状況管理機能ー

＜学習内容＞

　・WaitUntil クラス

設計

　ゲーム内の処理において、現在のゲームの進行状態がどのような場面であるかを判定する必要があるケースがあります。
ですが、Unity 自体にはそのような機能はないため、自作して、ゲームの進行状態を管理しておく必要があります。

　管理の方法には、enum を利用します。これは、列挙子としてゲームの進行状態の候補を事前に登録しておくことが出来、
かつ、変数に代入して管理を行う際には、列挙子のいずれか１つしか代入できないため、排他的な処理を作ることに適しているためです。

　ゲームの進行状態とは、単一の状態で表現することが重要になります。
ゲームプレイ中という状態とゲーム待機中という状態が、同じにあってはなりません。
よって、ある１つの状態になっている際には、他の状態にはならない(一緒に競合した状態を作らない)ことが大切です。

　enum による管理は、この部分を表現可能です。
つまり、enum の列挙子がＡという状態であるならば、他の列挙子であるＢやＣという状態にはならない、ということが保証されるため、
ゲームの進行状態を表現する際にとても運用しやすいと言えます。

　最初に GameState の enum を作成し、それを活用したゲームの進行状態を管理する機能を実装します。

　GameState 変数の管理は、GameManager クラスにおいて行い、他のクラスは、この GameManager クラスにて管理されている
GameState 変数の情報を「現在のゲームの進行状態」として参照する設計にしています。

GameState スクリプトを作成する

　enum のみのスクリプトを作成します。
以前にも作成したことがありますので、復習になります。

　GameState は、あくまでも定義(枠組み)を作っているだけです。
列挙子として登録されている情報が、利用できる状態になっていることを示していますが、
「現在はどの列挙子であるのか」という情報は、ここでは管理出来ません。

　そのため、次の GameManager スクリプトを修正して、そちらに GameState 型の変数を作成して、
その GameState 型の変数が、現在の列挙子を管理することになります。

GameState.cs

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

/// <summary>
/// ゲームの進行状態の種類
/// </summary>
public enum GameState {
    Wait,            // ゲームの準備前
    Play_Move,       // ゲームプレイ中。移動時
    Play_Mission,    // ゲージプレイ中。ミッション時
    GameUp,          // ゲーム終了(ゲームオーバー、ゲームクリア)
}

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

GameManager スクリプトを修正する

　GameState 型の変数の宣言を追加し、この値として、GameState 型で定義した列挙子の値を１つだけ代入して利用します。
２つ以上の列挙子は同時に代入されないため、これにより、「現在のゲーム内の列挙子の値」を「ゲーム内のゲームの進行状態」を表す情報として利用します。

　変数とは、スクリプトを記述するエンジニアが、自分で運用する方法を決定し、それにまつわる名称を付けることになります。
そのイメージを持つようにすることで、設計した内容をプログラム化していくことが可能になります。

　合わせて、Start メソッドを修正し、GameState 型の変数に代入処理を行って、現在のゲームの進行状態を更新していきます。

　今回であれば、Start メソッドが開始されたタイミングで、currentGameState 変数を、準備中の状態にしています。
そのため、GameManager クラスに関わらず、currentGameState 変数を参照することにより、すべてのクラスにおいて、ゲームの進行状態を「準備中」であることを利用できます。
例えば、準備中の状態であるならば、特定の処理は行わない、といった機能を実装することが出来るようになります。

　その後、Start メソッド内の処理がすべて終了したタイミングで、currentGameState 変数の値をプレイ・移動中の状態にしています。
これにより、currentGameState 変数は、ゲームが開始されたことを表現することになりますので、またそれに合わせた機能を作り出すことによって、
ゲームプレイ・移動中のみ許可される処理などを実装することが出来るようになります。

　なお、Start メソッド内には、次回以降で実装予定の処理を TODO で追記しています。
今後、どのような処理が追加されていくのかをイメージしておくことが大切です。

　自分で処理を組み立てるようになった場合にも、このように、今後追加しておきたい処理については、
こまめに TODO を残しておくようにするといいでしょう。

　なお、同様に GameState の切り替えの処理が StartMission メソッドと EndMission メソッドにおいても実装されています。
StartMission メソッドおいては currentGameState 変数の値をプレイ・移動中の状態からミッション中に変更し、
EndMission メソッド内においては currentGameState 変数の値をミッション中の状態からプレイ・移動中に変更しています。

　変数の切り替えをタイミングよく行っていくことで、ゲームの進行状態を GameManager スクリプトが管理しています。

　この実装方法は色々なゲームにおいても利用可能な処理になりますので、しっかりと学習しておいてください。

GameManager.cs

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

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

public class GameManager : MonoBehaviour {

    [SerializeField]
    private RailMoveController railMoveController;

    [SerializeField, Header("経路用のパス群の元データ")]
    private RailPathData originRailPathData;                      // 後程 List 化して複数のルートを管理できるようにします

    [SerializeField, Header("パスにおけるミッションの発生有無")]  // Debug 用
    private bool[] isMissionTriggers;

    [SerializeField]
    private PlayerController playerController;

    [SerializeField]
    private EventGenerator eventGenerator;

    [SerializeField, Header("ミッションで発生している敵のリスト")]
    private List<EnemyController> enemiesList = new List<EnemyController>();

    private int currentMissionDuration;


    ////*  ここから変数の宣言を１つ追加。  *////


    [Header("現在のゲームの進行状態")]
    public GameState currentGameState;


    private IEnumerator Start() {     //  <=  ☆　戻り値を void から IEnumerator 型に変更し、コルーチンメソッドにします。


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


        ////*　ここから TODO を追加　*////


        // ゲームの状態を準備中にする
        currentGameState = GameState.Wait;


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


        // TODO ルート用の経路情報を設定


        // イベント生成機能の準備
        eventGenerator.SetUpEventGenerator(this, playerController);


        ////*　ここから次回以降に実装予定の TODO を追加　*////


        // TODO 初期武器登録


        // TODO 武器取得イベント用の設定


        // TODO 初期武器設定


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


        // RailMoveController の初期設定
        railMoveController.SetUpRailMoveController(this);

        // パスデータよりミッションの発生有無情報取得
        SetMissionTriggers();

        // 次に再生するレール移動の目的地と経路のパスを設定
        railMoveController.SetNextRailPathData(originRailPathData);


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


        // 経路の準備が完了するのを待つ(この機能を利用するため、Start メソッドの戻り値を IEnumerator に変更してコルーチンメソッドに変えています)
        yield return new WaitUntil(() => railMoveController.GetMoveSetting());

        // ゲームの状態をプレイ中に変更する
        currentGameState = GameState.Play_Move;


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


    }

    /// <summary>
    /// パスデータよりミッションの発生有無情報取得
    /// </summary>
    private void SetMissionTriggers() {

        // 配列の初期化
        isMissionTriggers = new bool[originRailPathData.GetIsMissionTriggers().Length];

        // ミッション発生有無の情報を登録
        isMissionTriggers = originRailPathData.GetIsMissionTriggers();
    }

    /// <summary>
    /// ミッションの発生有無の判定
    /// </summary>
    /// <param name="index"></param>
    public void CheckMissionTrigger(int index) {

        if (isMissionTriggers[index]) {

            // ミッション発生
            PreparateMission(originRailPathData.pathDataDetails[index].missionEventDetail);

            Debug.Log("ミッション発生");
        } else {
            // ミッションなし。次のパスへ移動を再開
            railMoveController.CountUp();
        }
    }

    /// <summary>
    /// ミッションの準備
    /// </summary>
    /// <param name="missionEventDetail"></param>
    private void PreparateMission(MissionEventDetail missionEventDetail) {

        // ミッションの時間設定
        currentMissionDuration = missionEventDetail.missionDuration;


        // TODO 武器取得イベントか判定


        // ミッション内の各イベントの生成(敵、ギミック、トラップ、アイテムなどを生成)
        eventGenerator.PrepareGenerateEnemies(missionEventDetail.enemyPrefabs, missionEventDetail.eventTrans);

        // ミッション開始
        StartCoroutine(StartMission(missionEventDetail.clearConditionsType));
    }

    /// <summary>
    /// ミッション開始
    /// </summary>
    /// <param name="clearConditionsType"></param>
    /// <returns></returns>
    private IEnumerator StartMission(ClearConditionsType clearConditionsType) {


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


        // ゲームの進行状態をミッション中に変更
        currentGameState = GameState.Play_Mission;


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


        // ミッションの監視
        yield return StartCoroutine(ObservateMission(clearConditionsType));

        // ミッション終了
        EndMission();
    }

    /// <summary>
    /// ミッションの監視
    /// 各イベントの状態を監視
    /// </summary>
    /// <param name="clearConditionsType"></param>
    /// <returns></returns>
    private IEnumerator ObservateMission(ClearConditionsType clearConditionsType) {

        // クリア条件を満たすまで監視(currentMissionDuration 変数には、敵の数か、残り時間が入る)
        while (currentMissionDuration > 0) {

            // クリア条件が時間経過の場合
            if (clearConditionsType == ClearConditionsType.TimeUp) {

                // カウントダウン
                currentMissionDuration--;
            }

            // TODO 武器取得イベントかつ、武器選択のいずれかのボタンを押したら


            yield return null;
        }

        Debug.Log("ミッション終了");
    }

    /// <summary>
    /// ミッション終了
    /// </summary>
    public void EndMission() {

        // TODO 武器の取得イベントの場合には武器を取得せずにポップアップを閉じる


        // 今回分の敵の情報をクリア
        ClearEnemiesList();


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


        // ゲームの進行状態を移動中に変更
        currentGameState = GameState.Play_Move;


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


        // カメラの移動再開
        railMoveController.CountUp();
    }

    /// <summary>
    /// 敵の List をクリア
    /// </summary>
    private void ClearEnemiesList() {
        if (enemiesList.Count > 0) {
            for (int i = 0; i < enemiesList.Count; i++) {
                Destroy(enemiesList[i]);
            }
        }

        enemiesList.Clear();
    }

    /// <summary>
    /// 敵の情報を List から削除し、ミッション内の敵の残数を減らす
    /// </summary>
    /// <param name="enemy"></param>
    public void RemoveEnemyList(EnemyController enemy) {

        currentMissionDuration--;

        enemiesList.Remove(enemy);
    }

    /// <summary>
    /// 敵の情報をリストに追加
    /// </summary>
    /// <param name="enemy"></param>
    public void AddEnemyList(EnemyController enemy) {
        enemiesList.Add(enemy);
    }
}

＜WaitUntil クラス＞

　WaitUntil クラスは、コルーチン内で命令できる待機処理です。yield return をつけて new(インスタンス)します 。

　WaitUntil クラスにはコンストラクタ・メソッドがあり、インスタンスされると、引数で指定した条件を満たすまで、処理を一時中断して待機させることが出来ます。

　　　　// 経路の準備が完了するのを待つ
        yield return new WaitUntil(() => railMoveController.GetMoveSetting());

　今回の場合の条件は、【RailMoveController クラスに用意されている GetMoveSetting メソッドを毎フレーム実行し、その戻り値が true になったら】という条件を満たすことが必要になります。

RailMoveController クラス内にある tweenMove 変数が null でない場合に true の値が戻りますので、false の値は、この処理の場所で待機します。

戻り値が true になったら、処理は再度再開されて、次の処理に移ります。

参考サイト

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

GameManager ゲームオブジェクトの確認を行う

　新しい変数を追加しましたので、GameManager ゲームオブジェクトのインスペクターを確認します。

　enum 型の currentGameState 変数は、プルダウンメニューとして表示されます。

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

　こちらの currentGameState 変数の値もゲーム実行中にリアルタイムで変化しますので、デバッグを行う際にも活用してください。

RailMoveController スクリプトを修正する

　GameManager クラス内に追加された currentGameState 変数を利用して、特定の状態のみ、処理が行われるようにする機能を追加します。

　具体的には、currentGameState 変数の値が Play_Move の状態になるまで、カメラの移動を停止する機能を実装しています。
なぜそのような制御が必要になるのか、currentGameState 変数の切り替わるまでの処理の流れを確認しながら、考えてみてください。

　また、スクリプト内に処理の実装の確認を行う前に、自分で、どのタイミングに処理を追加すれば、今回実装したい処理、想定する処理になるのかを考えてみてください。
イメージを作って、実際に書いてみたりしながら処理を確認するようにすることで、ロジックを考えていく力を養うことが出来ます。

RailMoveController.cs

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

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

public class RailMoveController : MonoBehaviour
{
    [SerializeField]
    private Transform railMoveTarget;

    [SerializeField]
    private RailPathData currentRailPathData;

    private Tween tweenMove;
    private Tween tweenRotation;

    private Vector3[] paths;
    private float[] moveDurations;
    private int pathCount;

    private GameManager gameManager;


    /// <summary>
    /// RailMoveController の初期設定
    /// </summary>
    /// <param name="gameManager"></param>
    public void SetUpRailMoveController(GameManager gameManager) {　　　　　//　<=　GameManager より呼び出されます
        this.gameManager = gameManager;

        // TODO 他にもある場合には追記。必要に応じて引数を通じて外部から情報をもらうようにする

    }

    /// <summary>
    /// 次に再生するレール移動の目的地と経路のパスを取得して設定
    /// </summary>
    /// <param name="nextPathDataList"></param>
    public void SetNextRailPathData(RailPathData nextRailPathData) {　　　　　//　<=　GameManager より呼び出されます
        // 目的地取得
        currentRailPathData = nextRailPathData; ;

        // 移動開始
        StartCoroutine(StartRailMove());
    }

    /// <summary>
    /// レール移動の開始
    /// </summary>
    /// <returns></returns>
    public IEnumerator StartRailMove() {

        yield return null;

        // パスのカウントを初期化
        pathCount = 0;

        // 移動する地点を取得するための配列の初期化
        paths = new Vector3[currentRailPathData.GetPathTrans().Length];
        float totalTime = 0;

　　　　// 移動する位置情報と時間を順番に配列に取得
        for (int i = 0; i < currentRailPathData.GetPathTrans().Length; i++) {
            paths[i] = currentRailPathData.GetPathTrans()[i].position;
	    totalTime += currentRailPathData.GetRailMoveDurations()[i];
        }

　　　　// 各パスごとの移動時間を取得
        moveDurations = currentRailPathData.GetRailMoveDurations();

        // パスによる移動開始
        RailMove();


////*　TODO を３つ実装　*////


        // 移動を一時停止
        PauseMove();

        // ゲームの進行状態が移動中になるまで待機
        yield return new WaitUntil(() => gameManager.currentGameState == GameState.Play_Move);

        // 移動開始
        ResumeMove();


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


        Debug.Log("移動開始");
    }

    /// <summary>
    /// レール移動の一時停止
    /// </summary>
    public void PauseMove() {
        // 一時停止
        tweenMove.Pause();
　　　　tweenRotation.Pause();
    }

    /// <summary>
    /// レール移動の再開
    /// </summary>
    public void ResumeMove() {
        // 移動再開
        tweenMove.Play();
        tweenRotation.Play();
    }

    /// <summary>
    /// パスのカウントアップ(パスごとに動かす場合)
    /// </summary>
    public void CountUp() {
        pathCount++;
        Debug.Log(pathCount);

        // 移動
        RailMove();
    }

    /// <summary>
    /// 2点間のパスの目標地点を設定して移動
    /// </summary>
    public void RailMove() {

        // 残っているパスがない場合
        if (pathCount >= currentRailPathData.GetPathTrans().Length) {

            // DOTween を停止
            tweenMove.Kill();

            tweenMove = null;
            tweenRotation = null;


            // TODO 移動完了に伴い、移動回数をカウントアップ


            // TODO 移動先の確認。移動先が残っていない場合には、ゲームマネージャー側で分岐の確認(次のルート選定、移動先の分岐、ボス、クリアのいずれか)


            Debug.Log("分岐確認");

            return;
        }

        // パスの設定用の配列を宣言
        Vector3[] targetPaths;

        // パスのカウント数に応じて分岐してパスを設定
        if (pathCount == 0) {
            targetPaths = new Vector3[2] { railMoveTarget.position, paths[pathCount] };
        } else {
            targetPaths = new Vector3[2] { paths[pathCount -1], paths[pathCount] };            
        }

　　　　// パスの移動時間を設定
        float duration = moveDurations[pathCount];

        Debug.Log("スタート地点 :" + targetPaths[0]);
        Debug.Log("目標地点 :" + targetPaths[1]);
        Debug.Log("移動にかかる時間 :" + duration);

　　　　// パスの移動
        tweenMove = railMoveTarget.transform.DOPath(targetPaths, duration, pathType).SetEase(Ease.Linear).OnWaypointChange((waypointIndex) => CheckArrivalDestination(waypointIndex));

        // カメラの回転
        tweenRotation = railMoveTarget.transform.DORotate(currentRailPathData.pathDataDetails[pathCount].pathTran.eulerAngles, duration).SetEase(Ease.Linear);
        Debug.Log($" 回転角度 :  { currentRailPathData.pathDataDetails[pathCount].pathTran.eulerAngles } ");
    }

    /// <summary>
    /// パスの目標地点に到着するたびに実行される
    /// </summary>
    /// <param name="waypointIndex"></param>
    private void CheckArrivalDestination(int waypointIndex) {

        if (waypointIndex == 0) {
            return;
        }

        Debug.Log("目標地点 到着 : " + pathCount + " 番目");

        // 移動の一時停止
        PauseMove();

        // ミッションがあるか確認(ミッションが発生するかゲームマネージャー側で判定を行う)
        gameManager.CheckMissionTrigger(pathCount);

        // Debug用  次のパスをセットして移動を実行
        //CountUp();
    }


////*  メソッド１つを追加します  *////


    /// <summary>
    /// 移動用の処理が登録されたか確認
    /// </summary>
    /// <returns></returns>
    public bool GetMoveSetting() {
        return tweenMove != null ? true : false;
    }


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


}

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

　すべての処理を実装しましたので、処理の内容を見直して、流れを把握してから、ゲームを実行してください。

　どのような処理が制御されて、ゲームの挙動が変わるのかを自分で理解してから確認を行うようにしましょう。

　今回の修正により、どのゲームオブジェクトのインスペクターを確認すればいいのか、
どのようになれば正しい制御になっていると言えるのか、といった部分を自分で説明できるようしてください。

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

　=>　次は　手順１８　ー武器用のデータベース作成ー　です。