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

　前回の手順では武器の情報をデータベースにまとめる機能を追加しました。
この手順では、その武器のデータベースを活用し、現在、プレイヤーの使用している武器の情報を管理する機能を実装します。

手順１９ー使用している武器の情報の管理機能ー

設計

　PlayerController スクリプトには、武器の情報が各変数で用意されていますが、現在は固定値で利用しているため、
どのような武器を使っているか、という情報もなく、また、武器のデータ(攻撃力や射程)はゲーム内においては変化しません。

　そのため、この手順では、次の手順において、武器の切り替え機能を実装するにあたり、現在使用している武器の情報を管理できるようにし、
また、その武器のデータを固定値ではなく、使用している武器に応じて設定を行えるように処理を修正します。

　武器のデータについては、前の手順で作成した WeaponDataSO スクリプタブル・オブジェクトの情報を活用することにより、
データベースとして登録されている武器の情報をゲーム内に反映できる仕組みに修正を行います。

スクリプタブル・オブジェクトを管理する DataBaseManager スクリプトを作成する

　前回の手順で作成した武器のデータベースである WeaponDataSO スクリプタブル・オブジェクトをゲーム内で利用できるようにします。
　スクリプタブル・オブジェクトは今後も増えていく可能性がありますので、特定のクラスに専属で管理をさせることにより、
すべての処理をそのクラス経由で参照する設計にします。

　そのためのクラスとして DataBaseManager クラスをシングルトンデザインパターンとして作成しておきます。
他にもデータベースの機能を有する情報を管理する場合には、こちらのクラスで管理を行う設計にしています。

DataBaseManager.cs

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

using UnityEngine;

public class DataBaseManager : MonoBehaviour {

    public static DataBaseManager instance;

    public WeaponDataSO weaponDataSO;


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

    /// <summary>
    /// WeaponDataSO スクリプタブル・オブジェクトの中から、引数に指定された WeaponNo を持つ WeaponData の取得
    /// </summary>
    /// <param name="searchWeaponNo"></param>
    /// <returns></returns>
    public WeaponData GetWeaponData(int searchWeaponNo) {
        return weaponDataSO.weaponDatasList.Find(x => x.weaponNo == searchWeaponNo);
    }
}

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

DataBaseManager ゲームオブジェクトを作成し、DataBaseManager スクリプトをアタッチして設定を行う

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

インスペクター画像

　これで WeaponDataSO スクリプタブル・オブジェクトの情報を、ゲーム内で利用するための準備が整いました。

WeaponDetail スクリプトを作成する

　武器用のゲームオブジェクトにアタッチする前提で作成するスクリプトになります。
その武器が、どのような武器の情報を有しているかを管理するためのクラスを作成します。

WeaponDetail.cs

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

using UnityEngine;

public class WeaponDetail : MonoBehaviour {
    public WeaponData weaponData;
}

PlayerController スクリプトを修正する

　新しい変数の宣言を行い、現在使用している武器の番号を管理できるようにしましす。
また、 ChangeBulletData メソッドを新しく作成し、引数によって届いた武器の情報を、各武器用の変数の値に初期設定を行います。

PlayerController.cs

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

using System.Collections;
using UnityEngine;

/// <summary>
/// プレイヤー情報の管理クラス
/// </summary>
public class PlayerController : MonoBehaviour {

    private int hp;                // 現在のHp値
    private int bulletCount;       // 現在の弾数値

    [SerializeField, Header("最大Hp値")]
    private int maxHp;

    [SerializeField, Header("最大弾数値")]
    private int maxBullet;

    [SerializeField, Header("リロード時間")]
    private float reloadTime;

    [Header("弾の攻撃力")]
    public int bulletPower;

    [Header("弾の連射速度")]
    public float shootInterval;

    [Header("弾の射程距離")]
    public float shootRange;

    [Header("リロード機能のオン/オフ")]
    public bool isReloadModeOn;

    [Header("リロード状態の制御")]
    public bool isReloading;

    [SerializeField]
    private UIManager uiManagaer;


    ////*　新しい変数の宣言を１つ追加　*////


    public int currentWeaponNo;


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


    /// <summary>
    /// 弾数用のプロパティ
    /// </summary>
    public int BulletCount
    {
        set => bulletCount = Mathf.Clamp(value, 0, maxBullet);
        get => bulletCount;
    }

    //HP も同じようにプロパティ化できますが、今回はしていません。挑戦してみてください。


    void Start() {
        // Debug 用
        SetUpPlayer();
    }

    /// <summary>
    /// プレイヤー情報の初期設定
    /// </summary>
    public void SetUpPlayer() {

        // maxHp の設定があるか確認。なければ初期値 10 でセットして hp を設定
        hp = maxHp = maxHp == 0 ? 10 : maxHp;

        // maxBullet の設定があるか確認。なければ初期値 10 でセットして 弾数を設定
        BulletCount = maxBullet = maxBullet == 0 ? 10 : maxBullet;

        // UI にライフ用アイコンを最大HP数だけ生成する
        uiManager..SetPlayerInfo(maxHp);


        // TODO そのほかの初期設定があればここで行う

    }

    /// <summary>
    /// HPの計算と更新
    /// </summary>
    public void CalcHp(int amount) {
        hp = Mathf.Clamp(hp += amount, 0, maxHp);    // プロパティを作成してもいいです

        Debug.Log("現在のHp : " + hp);               // UI で hp が確認できるようになったらコメントアウトします

        // HP 表示の更新
        uiManagaer.UpdateDisplayLife(hp);

        if (hp <= 0) {
            Debug.Log("Game Over");
        }
    }

    /// <summary>
    /// 弾数の計算と更新
    /// </summary>
    /// <param name="amout"></param>
    public void CalcBulletCount(int amout) {

        BulletCount += amout;

        Debug.Log("現在の弾数 : " + BulletCount);      // UI で弾数が確認できるようになったらコメントアウトします

        // TODO 弾数のUI表示更新

    }

    /// <summary>
    /// 弾数のリロード
    /// </summary>
    public IEnumerator ReloadBullet() {

        // リロード状態にして、弾の発射を制御する
        isReloading = true;

        // リロード
        BulletCount = maxBullet;

        Debug.Log("リロード");                         // UI で弾数が確認できるようになったらコメントアウトします


        // TODO 弾数のUI表示更新


        // TODO SE


        // リロードの待機時間
        yield return new WaitForSeconds(reloadTime);

        // 再度、弾が発射できる状態にする
        isReloading = false;
    }

    private void OnTriggerEnter(Collider other) {

        // TODO 敵からの攻撃によって被弾した場合の処理

        // TODO ボスや敵の攻撃範囲を感知しないようにするためにタグでも判定するか、レイヤーを設定して回避する

    }


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


    /// <summary>
    /// 武器(バレット)の情報を変更して武器切り替え
    /// </summary>
    /// <param name="weaponData"></param>
    public void ChangeBulletData(WeaponData weaponData) {

        // 現在使用している武器の番号を保持
        currentWeaponNo = weaponData.weaponNo;

        // 武器の情報を各変数に設定
        bulletPower = weaponData.bulletPower;
        maxBullet = weaponData.maxBullet;

        reloadTime = weaponData.reloadTime;
        shootInterval = weaponData.shootInterval;
        shootRange = weaponData.shootRange;

        bulletCount = maxBullet;

        // TODO すでに使用したことのある武器である場合


        // TODO 弾数を前回の残弾数にする

    }


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


}

PlayerController スクリプトのアタッチされているゲームオブジェクトの設定を行う

　PlayerController スクリプトのアタッチされているゲームオブジェクトを選択してインスペクターより、
hp 変数以外の武器の設定情報に関連する値をすべて 0 に設定してください。

　今回 PlayerController スクリプト内に新しく追加した ChangeBulletData メソッドを利用することで、
これらの武器の設定値について、WeaponDataSO スクリプタブル・オブジェクトの情報を引数を通じて受け取り、
その情報を各変数に設定をします。

　そのため、ゲーム実行前のデータはすべて 0 ですが、ゲームが実行された際には各変数に情報が代入されることになります。

　この機能が実装できることで、次の武器の切り替え処理が実装出来るようになります。

インスペクター画像

　以上で設定は完了です。

GameManager スクリプトを修正する

　Start メソッドに処理を追加し、PlayerController スクリプトに追加した ChangeBulletData メソッドの呼び出し命令を実行して、
プレイヤーの初期武器の設定を行うようにします。初期武器のデータは WeaponDataSO スクリプタブル・オブジェクトに登録されている情報を活用します。

　複数のクラスのメソッドを組み合わせた処理のロジックになっているため、どの処理がどのようにつながって利用されているか、
処理の流れを把握しながら、混乱しないように整理しておいてください。

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

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


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


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


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


        // TODO 初期武器登録


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


        // 初期武器設定
        playerController.ChangeBulletData(DataBaseManager.instance.GetWeaponData(0));


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


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

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

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

        // 経路の準備が完了するのを待つ
        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);
    }
}

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

　処理の流れを理解した上で、ゲームのデバッグを行うようにしましょう。
どのような処理が実装されており、それによって、どういった処理が作られているかを理解しておくことにより、
万が一、エラーが発生した場合や、調整を行いたいような場合においても修正を行うことが出来るようになります。

　ゲームを実行し、PlayerController のアタッチされているゲームオブジェクトのインスペクターを確認します。

　武器の情報を表す各変数が WeaponDataSO スクリプタブル・オブジェクトのデータの内容に切り替わっていれば、制御成功です。

ゲーム実行前

ゲーム実行時

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

　=>　次は　手順２０　ー使用する武器の切り替え機能ー　です。