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

　前回にひきつづき、２回に分けて、移動後の地点において、ミッションが発生するかどうかを判定する機能を実装します。

　今後の処理を見込んで、処理を作りたい場所に TODO を記述するようにします。
実際に自分で設計を考えてロジックを組む際にも役立ちますので、使い方を覚えていきましょう。

手順１０　ーミッション発生の判定機能ー

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

＜学習内容＞

　・TODO の使い方

１．設計

　この手順では前回作成した移動地点の情報を元に、スクリプトによって移動後の地点でミッション(イベント)が発生するかを判定する機能を実装します。
RailPathData クラス内には bool 型の IsMissionTrigger 変数が用意されており、この値が true である場合に、ミッションを実行するようにします。

　ミッションは敵の生成処理を行ったり、武器の取得を行ったりするイベント群の総称です。
そのため、この機能を実装することにより、移動後の地点では、敵が出現したり、武器の取得を行うための準備が出来ます。

　各クラスの役割と役割を実装するための修正は以下の通りです。

　〇RailPathData　　　　　　新しくミッション判定用の変数を追加する
　　　　　　　　　　　　　　現在の状態のまま変数を追加する方法もあるが、ここでは RailPathData クラス内に PathDataDetail クラスを新しく作成して経路の情報を１つのクラスにまとめて運用する

　◇RailMoveController　　　CheckArrivalDestination メソッド内で GameManager クラス内の CheckMissionTrigger メソッドを実行する

　　　　　　　　　　　　　　SetUpRailMoveController メソッドを作成して GameManager クラスから実行し、RailMoveController クラスの初期設定を行う
　　　　　　　　　　　　　　合わせて、SetNextRailPathData メソッドを作成して GameManager クラスから実行し、RailPathData クラスの情報を外部のクラスから引数を通じて受け取るようにする
　　　　　　　　　　　　　　このメソッド内で移動を実行するメソッドである StartRailMove メソッドを実行するようにする(経路のセットがない限り、移動を実行しないようにする)
　　　　　　　　　　　　　　よってデバッグ用に Start メソッド内で実行していた StartRailMove メソッドはコメントアウトする

　◇GameManager　　　　　　 SetMissionTrigger メソッドで、各地点ごとのミッションの発生有無の情報を isMissionTriggers 配列変数として作成しておく
　　　　　　　　　　　　　　CheckMissionTrigger メソッドが実行されたら、isMissionTriggers 配列変数を確認して、ミッションの発生有無の判定を行う

　　　　　　　　　　　　　　RailMoveController クラス内の２つのメソッドを実行する命令を用意する

　今回は RailMoveController スクリプトの修正を修正し、新しく GameManager スクリプトの作成を行います。

２．RailMoveController クラスを修正する

　新しく２つのメソッドを作成します。どちらも GameManager クラスから呼び出されることを想定して引数を準備します。

　また、各パスの地点に到着するたびに CheckArrivalDestination メソッドから GameManager クラスにあるミッションの発生の確認用のメソッドを実行します。
この時点で移動が一旦停止しますので、ミッションの発生が発生しない場合のみ、GameManager クラス側から ResumeMove メソッドに命令を受けて、移動を再開するようにします。

　このような制御を行うことにより、ミッションの発生前には必ず移動を停止し、ミッションの発生状態に応じて移動を再開する制御が実装出来ます。

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 tween;
    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());
    }


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


    ////*  SetNextRailPathData メソッド内で StartRailMove メソッドの呼び出し命令をおこなうので、Start メソッド内の処理は不要になります。コメントアウトしてください  *////


    //void Start() {
    //    // Debug 用  レール移動の開始
    //    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 移動を一時停止


        // TODO ゲームの進行状態が移動中になるまで待機


        // TODO 移動開始

        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();


        ////*  TODO を実装します  *////


        // ミッションがあるか確認(ミッションが発生するかゲームマネージャー側で判定を行う)
        // GameManager 側にまだ処理を作成していないので、この部分がエラーになります。一時、コメントアウトしておいてください
        gameManager.CheckMissionTrigger(pathCount);     //　☆　追加します


        // Debug用  次のパスをセットして移動を実行
        //CountUp();　　　　　　　　　　　　　　　　　　　 //　☆　コメントアウトします


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


    }
}

７．GamaManager クラスを作成する

　RailMoveController クラスに登録していた RailPathData クラスの経路情報を、GameManager クラスに登録します。
こちらに登録されている情報を RailMoveController クラスへと引数を利用して送り出します。

　そのための情報やメソッドを準備するとともに、一緒にミッション用の処理も準備します。
RailMoveController クラスより、ミッションの発生の確認命令が届きますので、それに応じて、その都度、ミッションの発生有無を確認します。

　確認後の実処理はこれからになりますので、まずは Debug.Log メソッドを利用して、判定処理が正常に動作しているかのみを確認し、移動の再開を行います。

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;


    private void Start() {

        // TODO ゲームの状態を準備中にする


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


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

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

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


        // TODO 経路の準備が完了するのを待つ(Start メソッドの戻り値を IEnumerator に変更してコルーチンメソッドに変える)


        // TODO ゲームの状態をプレイ中に変更する

    }

    /// <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]) {
            // TODO ミッション発生
            Debug.Log("ミッション発生");

            // Debug 用　いまはそのまま進行
            railMoveController.CountUp();

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

８．GameManager ゲームオブジェクトを作成し、GameManager クラスをアタッチして設定を行う

　ヒエラルキーの空いている場所で右クリックをしてメニューを開き、Create Empty で新しいゲームオブジェクトを作成します。
名前を GameManager に変更し、作成した GameManager クラスをアタッチしてください。

　インスペクター上から変数をアサインできますので、railMoveController 変数には RailMoveController ゲームオブジェクト、
originRailPathData には RailPathData ゲームオブジェクトをアサインしてください。

＜インスペクター画像＞

　以上で設定は完了です。

９．RailMoveController ゲームオブジェクトの設定を行う

　RailPathData の情報は GameManager から RailMoveController へその都度送られるようにします。

　GameManager はすべての経路の情報を管理し、RailMoveController は現在移動を行っている経路のみを管理するようにします。

　そのため、RailMoveController の currentRailPathData 変数は None に変更してください。
ここにゲーム開始時に動的に RailPathData が代入されるように制御を行います。

＜インスペクター画像＞

　以上で設定は完了です。

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

クラス図を見ると、どちらも参照している情報は RailPathData であることが分かります。

＜クラス図＞

処理の流れを把握し、ゲームを実行すると、RailPathData が RailMoveController クラスの変数内に代入されることを確認してください。

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

　Debug.Log メソッドを活用し、ミッションの判定処理が正常に動いていることも合わせて確認しておいてください。

＜Console ビュー画像＞

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

　=>　次は　手順１１　ー敵の作成ー　です。