ベルトスクロールアクション　エリア内の敵の管理 - i-school

　ベルトスクロールアクションでは各エリア単位で敵が生成されます。引き続き、このロジックを設計していきます。

設計

　前回の手順で、敵が自動生成を繰り返すサイクルが実装されました。
この手順では生成された敵の情報をListで管理し、エリア内の敵の状態を把握できるようにします。

　エリアが開始された際、Listをリセットします。
　敵が生成された際には、Listに敵の情報を追加します。
　敵が倒された場合にはListから削除し、エリア内で討伐された数を加算します。

　このListの情報を元に、次の手順ではエリアのクリア状態とゲームの進行状態とを紐づけて管理を行えるようにします。

実装の手順

　１．GameManagerクラスを修正する　ーListを用意してエリア内の敵の情報を管理できるようにするー
　２．Enemyクラスを修正する
　３．StageListスクリプタブル・オブジェクトに出現する敵の情報を登録する
　４．GameManagerクラスを修正する　ーStageListと各データを同期させるー
　５．ゲームを実行して動作を確認する

新しく学習する内容

　・Listの使い方(Clearメソッド、Addメソッド、Removeメソッド)

１．GameManagerクラスを修正する　ーListを用意してエリア内の敵の情報を管理できるようにするー

　新しく変数を２つ追加します。敵の情報を管理するための enemyList 変数と、エリア内の敵の討伐数をカウントする destroyConut 変数です。

　ListはEnemyクラスで用意します。これはインスタンシエイトされて生成された敵の情報が Enemy クラスに代入されるため、
その情報をそのままListへ追加できるようにするためでもあり、敵の管理をEnemyクラスで行うようにするためでもあります。

　GameObject型ではなく、Enemyクラスで管理する利点としまして、クラスの場合には gameObject 変数を利用してGameObject型へのアクセスもすぐにできるためです。
逆にGameObject型で管理をしてしまうと、Enemyクラスを利用するためには毎回GetComponent処理が必要になります。

　そのため、何かをまとめて管理する場合には、ただまとめるだけではなく、その情報をすぐに利用しやすい形にしてList化しておく設計が重要になります。

GameManager.cs

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

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

public class GameManager : MonoBehaviour
{
    // 宣言フィールドは変更なし。以下の２つの変数を新しく宣言フィールドに追加する


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

    // 生成した敵を入れるリスト
    public List<Enemy> enemyList = new List<Enemy>();

    // このエリア内の倒した敵の数
    public int destroyCount;

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


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

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

    private void SetUpNextArea() {
        // 移動範囲制限
        leftLimitPos = currentStageData.areaDatas[areaIndex].areaMoveLimit.horizontalLimit.left;
        rightLimitPos = currentStageData.areaDatas[areaIndex].areaMoveLimit.horizontalLimit.right;
        forwordLimitPos = currentStageData.areaDatas[areaIndex].areaMoveLimit.depthLimit.forword;
        backLimitPos = currentStageData.areaDatas[areaIndex].areaMoveLimit.depthLimit.back;

        // 敵の生成数を初期化
        generateCount = 0;

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

        // 敵の討伐数を初期化
　　　　destroyCount = 0;

        // 敵のリストをリセット(空にする) 
        enemyList.Clear();

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

        // 最初に敵が出現するまでの時間を設定
        appearTime = Random.Range(5, 10);
    }

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

    private void GenerateEnemy(Vector3 charaPos, int enemyIndex) {
        // 左右のどちらに生成するかランダムで決める

        int direction = Random.Range(0, 2);
        charaPos.x = direction == 0 ? charaPos.x += 2.5f : charaPos.x -= 2.5f;

        // ランダムな位置を設定

        float posX = charaPos.x;
        float posZ = charaPos.z;

        Vector3 generatePos = new Vector3(posX + Random.Range(-0.5f, 0.5f), charaPos.y, posZ + Random.Range(-0.5f, 0.5f));

        // まだエリアのデータは使わずに敵を生成。生成する際にEnemy型のプレファブを使用するので、左辺に用意する変数の型もEnemy型としている
        Enemy enemy = Instantiate(enemyPrefab, generatePos, Quaternion.identity);

        // Enemy型で生成して変数に代入しているので、すぐにメソッドの呼び出しができる
        enemy.SetUpEnemy(this); 
       
////* ここから追加 *////

        // 生成された敵の情報を Enemy クラス単位でListに追加する
        enemyList.Add(enemy);

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

        // 生成数を加算
        generateCount++;

　　　　// 次に敵が出現するまでの時間を設定
        appearTime = Random.Range(5, 10);
    } 

////* メソッドを新しく１つ追加。ここから追加 *////

    /// <summary>
    /// 討伐数を加算してenemyListから倒した敵を削除
    /// </summary>
    /// <param name="enemy"></param>
    public void RemoveEmenyList(Enemy enemy) {    // <= 引数には倒された敵のクラスが入っています
        destroyCount++;

　　　　// 倒された敵の情報をList内から削除
        enemyList.Remove(enemy);
    }

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

＜Listの使い方(Clearメソッド、Addメソッド、Removeメソッド)＞

　Listクラスは<T>にジェネリック型（任意の型）を指定して、同じデータ型をまとめて管理するコレクション機能を持つクラスです。
配列と異なり、要素を自由に追加・削除できます。(要素数が可変する)
Listを利用する場合には配列と同様に初期化が必要ですが、Listでは初期化時に要素数の宣言が不要です。

　そのため、予め要素数の確定しているデータを扱う場合には配列を、要素数が未確定であったり可変長であるデータについてはListを利用するようにします。

　ここでは今回利用しているListクラスの持つメソッドについて説明します。

List.Clear()

　List内のすべての要素を削除します。Clearメソッドには引数はありません。

　enemyList.Clear();

List.Add(T型)

　Listの末尾に引数で指定した要素(データ)を追加します。Listで宣言している型と同じ型であればAddすることが出来ます。

  Enemy enemy = Instantiate(enemyPrefab, generatePos, Quaternion.identity);

  enemyList.Add(enemy);　　　// List<Enemy>型なので、enemy 変数の型が Enemy型であればAddできる

List.Remove(T型)

　List内にある要素から、引数で指定した要素を削除します。こちらも同じ型である必要があります。

  public void RemoveEmenyList(Enemy enemy) { 

  enemyList.Remove(enemy);　　　// List<Enemy>型なので、enemy 変数の型が Enemy型であればRemoveできる

　他にも便利なメソッドがありますので、調べてみてください。

参考サイト

ITSakura様
C# Listの使い方のサンプル
https://itsakura.com/csharp-list

２．Enemyクラスを修正する

　敵が倒された際に、GameManagerクラスのRemoveEmenyListメソッドを呼び出すようにして、敵の管理用のListから敵の情報を削除するようにします。
こうすることで敵の生成と削除の両方がListを使って管理できるようになります。

Enemy.cs

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

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

public class Enemy : MonoBehaviour
{
    public bool isDebug;

    private GameManager gameManager;

    /// <summary>
    /// Enemyクラスの初期設定
    /// </summary>
    /// <param name="gameManager"></param>
    public void SetUpEnemy(GameManager gameManager) {
        this.gameManager = gameManager;
        //Debug.Log(this.gameManager);     <= 取得できていれば、削除したり、コメントアウトして問題ありません。
    }

    void Start()
    {
        if (isDebug) {
            StartCoroutine(DestroyEnemy(3.0f));
        }
    }

    /// <summary>
    /// 敵を破壊
    /// </summary>
    /// <param name="waitTime"></param>
    /// <returns></returns>
    private IEnumerator DestroyEnemy(float waitTime = 0.0f) {
        yield return new WaitForSeconds(waitTime);

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

        // 討伐数を加算し、敵管理用のリストから倒した敵を削除するメソッドの呼び出し
        gameManager.RemoveEmenyList(this);

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

        Destroy(gameObject);
    }

    // Update is called once per frame
    void Update()
    {
        
    }
}

３．StageListスクリプタブル・オブジェクトに出現する敵の情報を登録する

　ステージ1のエリア1について、出現する敵の情報を登録します。

　StageListスクリプタブル・オブジェクトの、StageDatas Element[0] / AreaDatas Element[0] 内にある AppearNum の Size を 0 から 3 に変更します。
このAppearNumが出現する敵の種類と数を登録する部分です。

StageListスクリプタブル・オブジェクトのインスペクター画像①　階層表示

　敵の種類はまだ1つしかありませんので、Element 0 -2 の数字はすべて 0 で登録します。
これは、敵のプレファブを管理する配列の、 0 番目の要素数にある敵を生成する、という敵の種類を決定する処理に利用します。
　
　Elementの数が出現する敵の数です。今回は Size 3 ですので、3体の敵が生成されることになります。

StageListスクリプタブル・オブジェクトのインスペクター画像②　AppearNum部分のみ

４．GameManagerクラスを修正する　ーStageListと各データを同期させるー

　登録した敵の情報をゲーム内に反映して利用するために、GameManagerクラスを修正します。

　敵のプレファブ情報を単体からListに変更し、複数の敵のプレファブを登録できるように変更します。
　
　エリアの情報を使い、敵の生成数と討伐数を比べて、エリア内のすべての生成された敵を倒している場合には、エリアクリアとするように処理を追加しておきます。
ただしこのとき、討伐数と生成数とを単純に比べてしまうと、エリア内ですべての敵を倒していない状態でもエリアクリアと判定してしまうため
エリア内のすべて敵の生成が終了し、かつ、すべての敵を討伐している場合に限り、エリアクリアとなるように制御を行います。
詳細は次の手順で記載するので、ここでは判定し、デバッグでクリアと表示だけするようにします。

GameManager.cs

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

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

public class GameManager : MonoBehaviour
{
    // 宣言フィールドは変更なし。以下の２つの変数を新しく宣言フィールドに追加する


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

    // エリア内の敵の生成がすべて終了しているか確認するための変数。 true なら生成完了
    public bool isCompleteGenerate;

    // 生成する敵のプレファブ
    //public Enemy enemyPrefab;    <= この変数を削除し、下記のListにして登録します。これにより、敵の種類を自由に設定できます。

    public List<Enemy> enemyPrefabs = new List<Enemy>();

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


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

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

    private void SetUpNextArea() {
        // 移動範囲制限
        leftLimitPos = currentStageData.areaDatas[areaIndex].areaMoveLimit.horizontalLimit.left;
        rightLimitPos = currentStageData.areaDatas[areaIndex].areaMoveLimit.horizontalLimit.right;
        forwordLimitPos = currentStageData.areaDatas[areaIndex].areaMoveLimit.depthLimit.forword;
        backLimitPos = currentStageData.areaDatas[areaIndex].areaMoveLimit.depthLimit.back;

        // 敵の生成数を初期化
        generateCount = 0;

        // 敵の討伐数を初期化
　　　　destroyCount = 0;

        // 敵のリストをリセット(空にする) 
        enemyList.Clear();


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

        // エリアの敵をすべて生成しているか確認用の変数を初期化
        isCompleteGenerate = false;

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


        // 最初に敵が出現するまでの時間を設定
        appearTime = Random.Range(5, 10);
    }

    void Update() {

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

　　　　// エリアごとの敵の生成数と現在の生成数を比べて、すべて生成済の場合には生成の処理をしない
        if (generateCount >= currentStageData.areaDatas[areaIndex].appearNum.Length) {
            return;
        }

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

　　　　// 敵の生成まで時間をカウントアップ
        generateTimer += Time.deltaTime;

        // 生成までの時間が待機時間を超えたら
        if (generateTimer >= appearTime) {

            // カウントを元に戻し、次のカウントに備える
            generateTimer = 0;

            // 敵を生成
            GenerateEnemy(playerController.transform.position, generateCount);         
        }
    }

 　 /// <summary>
    /// 敵の生成
    /// </summary>
    /// <param name="charaPos"></param>
    /// <param name="enemyIndex"></param>
    private void GenerateEnemy(Vector3 charaPos, int enemyIndex) {
        // 左右のどちらに生成するかランダムで決める
        int direction = Random.Range(0, 2);
        charaPos.x = direction == 0 ? charaPos.x += 2.5f : charaPos.x -= 2.5f;

        // ランダムな位置を設定
        float posX = charaPos.x;
        float posZ = charaPos.z;
        Vector3 generatePos = new Vector3(posX + Random.Range(-0.5f, 0.5f), charaPos.y, posZ + Random.Range(-0.5f, 0.5f));

        // StageListに登録した敵の情報を元に敵を生成。生成する際にEnemy型のプレファブを使用するので、左辺に用意する変数の型もEnemy型としている
        Enemy enemy = Instantiate(enemyPrefabs[currentStageData.areaDatas[areaIndex].appearNum[enemyIndex]], generatePos, Quaternion.identity);

        // Enemy型で生成して変数に代入しているので、すぐにメソッドの呼び出しができる
        enemy.SetUpEnemy(this); 
       
        // 生成された敵の情報を Enemy クラス単位でListに追加する
        enemyList.Add(enemy);

        // 生成数を加算
        generateCount++;


////* ここから修正と追加 *////

　　　　// エリア内の敵をすべて生成したか確認
        if (generateCount >= currentStageData.areaDatas[areaIndex].appearNum.Length) {
　　　　　　// 生成が終了している場合には、生成完了とする
            isCompleteGenerate = true;
        } else {
            // 敵の生成が終了していない場合には、次の敵が出現するまでの時間を設定
            appearTime = Random.Range(5, 10);
        }

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

    } 

    /// <summary>
    /// 討伐数を加算してenemyListから倒した敵を削除
    /// </summary>
    /// <param name="enemy"></param>
    public void RemoveEmenyList(Enemy enemy) {    // <= 引数には倒された敵のクラスが入っています
        destroyCount++;

　　　　// 倒された敵の情報をList内から削除
        enemyList.Remove(enemy);

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

       // エリア内の敵の状況を確認 
       CheckAreaClear();

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

    }


////* 新しいメソッドを１つ、ここから追加 *////

    /// <summary>
    /// エリア内の敵の生成状況と討伐状況を確認してエリアクリアかどうか判定
    /// </summary>
    private void CheckAreaClear() {
        // 敵の生成がすべて終了していない場合にはクリアにしない
        if (!isCompleteGenerate) {
            return;
        }

        // エリア内の生成した敵の数と討伐した敵の数が同数以上なら
        if (destroyCount >= generateCount) {
            // TODO 次のエリアへ移行するための準備処理を追加

            Debug.Log("エリア　クリア");
        }
    }

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

}

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

　GameManagerゲームオブジェクトのインスペクターを確認し、EnemyPrefabs変数のSizeを変更して、生成する敵のプレファブを登録します。
まだ1体しか敵のプレファブがなければ Size 1 にして、いままで使用していたのと同じように敵のプレファブを1体だけ登録します。増えたらSizeを変更して追加します。

GameManagerゲームオブジェクトのインスペクター画像①　EnemyPrefabs Size 0(一番下の項目。未設定)

GameManagerゲームオブジェクトのインスペクター画像②　EnemyPrefabs Size 1 にして、Enemy用ゲームオブジェクトをProject内からアサインしている状態

　ゲームを実行して、動作を確認します。

　生成された敵がEnemyListに追加されるか確認します。

　Enemyはデバッグモードのままのため、生成後に自動的に破壊されます。
その際にEnemyListから削除されているか、またDestroyConutが加算されているかを確認します。

　エリアの敵の生成数である AppearNum の Size 3 と、DestroyConutの値が同じ 3 になった際に、Debug.Logにエリアクリアの文字が表示されるか確認します。
GenerateCount が 3 未満の際に(エリア内のすべての敵の生成が終了していない)、エリアクリアが出てしまわないかも合わせて確認します。

検証動画①　敵が破壊されたときに、EnemyListからの削除とDestroyConutの加算を確認する
https://gyazo.com/52e62090b3d5369d6cf98cd0c0633ad3

検証動画②　すべての敵の生成が終了している状態で敵が破壊されてDestroyConutが生成数と同じ値になったときに、Debug.Logにエリアクリアと表示される
https://gyazo.com/4508012e4adfd6aabb52bef83af67a24

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

設計

実装の手順

新しく学習する内容

１．GameManagerクラスを修正する ーListを用意してエリア内の敵の情報を管理できるようにするー

＜Listの使い方(Clearメソッド、Addメソッド、Removeメソッド)＞

List.Clear()

List.Add(T型)

List.Remove(T型)

２．Enemyクラスを修正する

３．StageListスクリプタブル・オブジェクトに出現する敵の情報を登録する

４．GameManagerクラスを修正する ーStageListと各データを同期させるー

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

１．GameManagerクラスを修正する　ーListを用意してエリア内の敵の情報を管理できるようにするー

４．GameManagerクラスを修正する　ーStageListと各データを同期させるー