パズルゲーム　発展１６ - i-school

　引き続き、ボム機能の制作をおこないます。

　この手順ではいままでの機能を統合し、ボムの生成と削除を行えるようにします。

＜ボムの生成＞

＜新しく学習する内容＞

　・List<T>.AddRange(IEnumerable<T>) メソッド

GameManager スクリプトを修正する

　ボム用の変数を新しく３つ追加します。

　また、発展１４にて干支を削除する処理をメソッド化してありますので、
そちらを活用するためのメソッドを新しく１つ作成します。

　ボムの機能は、効果範囲内にある干支をすべて削除する、という機能ですので、
Bomb スクリプトの方では効果範囲にあるすべての干支の情報を収集する処理を記述しています。
そのため、削除の処理まではありませんので、削除の部分については GameManager に依頼をする、という流れです。

GameManager.cs

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

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

public class GameManager : MonoBehaviour
{
　　// いままでの変数はそのままなので省略

    
////*　新しく宣言フィールドに変数を３つ追加　*////


　　[SerializeField]
　　private int bombGenerateCount = 6;　　// ボムの生成に必要なチェーン数
	
　　[SerializeField]
　　private float bombRadius = 1.0f;　　　// ボムの効果範囲
	
　　[SerializeField] 
　　private Bomb bombPrefab;　　　　　　　// ボムのプレハブをアサインするための変数


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


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

    public IEnumerator PreparateGame() {
        // 変更なしのため省略
    }

    private IEnumerator SetUpEtoTypes(int typeCount) {
        // 変更なしのため省略
    }

    private IEnumerator CreateEtos(int count) {
        // 変更なしのため省略
    }

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

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

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


////* OnEndDragメソッド内にボムの生成を判定する処理を追加 *////


    private void OnEndDrag() {


////*　追加　*////


　　　　// つながっている干支が指定数以上あったら
	if (linkCount >= bombGenerateCount) {

　　　　　　// ボム生成
	　　Bomb bomb = Instantiate(bombPrefab, lastSelectEto.transform);
	　　bomb.transform.SetParent(etoSetTran);

　　　　　　// ボムの設定
	　　bomb.SetUpBomb(this, bombRadius);

	　　Debug.Log("ボム生成");
　　　　}
	

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


　　　　// つながっている干支が3以上あったら
	if (eraseEtoList.Count >= 3) {
			
	　　// 選択されている干支を消す
	　　EraseEtos();　　//　←　削除する処理をメソッド化

	} else {
	    for (int i = 0; i < eraseEtoList.Count; i++) {
		// 選んだ数か2個以下の場合　各干支のboolを解除する
		eraseEtoList[i].isSelected = false;　
		ChangeEtoAlpha(eraseEtoList[i], 1.0f);
	    }
	}
	firstSelectEto = null;
	lastSelectEto = null;
	currentEtoType = null;
    }


////*　発展１４でメソッド化している部分　*////


　　/// <summary>
　　/// 選択されている干支を消す
　　/// </summary>
　　/// <param name="eraseCount"></param>
　　public void EraseEtos() {
		
　　　　// 選択されている干支を消す
	for (int i = 0; i < eraseEtoList.Count; i++) {

	　　// 干支リストから取り除く
	　　etoList.Remove(eraseEtoList[i]);

　　　　　　// エフェクト生成
	　　GameObject effect = Instantiate(eraseEffectPrefab, eraseEtoList[i].gameObject.transform);
	　　effect.transform.SetParent(etoSetTran);

	　　// 干支を削除
	　　Destroy(eraseEtoList[i].gameObject);

	　　SoundManager.instance.PlaySE(SoundManager.SE_Type.Erase);
	}

	// スコアと消した干支の数の加算
	AddScores(currentEtoType, eraseEtoList.Count);

	// スキルポイント加算
	uiManager.AddSkillPoint(eraseEtoList.Count);
			
	// TODO ４つ以上消えていたら、ボーナス

	// 消した干支の数だけ新しい干支をランダムに生成
	StartCoroutine(CreateEtos(eraseEtoList.Count));
	eraseEtoList.Clear();
　　}


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


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

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

    private void ChangeEtoAlpha(Eto dragEto, float alphaValue) {
        // 変更なしため省略
    }

    private void AddScores(EtoType? etoType, int count) {
        // 変更なしため省略
    }

    private IEnumerator GameUp() {   
        // 変更なしため省略
    }

    private IEnumerator MoveResultPopUp() {
        // 変更なしため省略
    }

    /// <summary>
    /// 最も数の多い干支のタイプをまとめて削除する
    /// </summary>
    public void DeleteMaxEtoType() {
        // 変更なしため省略
    }

    /// <summary>
    /// 選択されたスキルをボタンに登録
    /// </summary>
    /// <param name="skillType"></param>
    /// <returns></returns>
    private IEnumerator SetUpSkill(SkillType skillType) {
        // 変更なしため省略
    }

    /// <summary>
    /// スキルボタンに登録するスキルのメソッドを取得して戻す
    /// </summary>
    /// <param name="chooseSkillType"></param>
    /// <returns></returns>
    public UnityAction GetSkill(SkillType chooseSkillType) {
        // 変更なしため省略
    }


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


　　/// <summary>
　　/// 複数の削除候補の干支を削除リストにまとめて追加してから削除
　　/// このメソッドを Bomb スクリプトから実行する
　　/// </summary>
　　/// <param name="eraseEtos"></param>
　　public void AddRangeEraseEtolList(List<Eto> eraseEtos) {

　　　　// 複数の削除候補の干支を削除リストにまとめて追加
	eraseEtoList.AddRange(eraseEtos);

	// 干支がつながっている数を初期化
	linkCount = 0;
		
	// 削除
	EraseEtos();
　　}


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


}

　スクリプトを修正したらセーブします。

＜List<T>.AddRange(IEnumerable<T>) メソッド＞

　List に用意されているメソッドです。

　Add メソッドでは要素を１つずつ List に追加することができますが、AddRange メソッドは引数に List を与えることで
与えた List の並びのまま、一括で追加を行ってくれます。List 内の追加される位置は、現在の要素の最後(末尾)の部分からです。

　List の統合とも言えます。

　// 複数の削除候補の干支を削除リストにまとめて追加
　eraseEtoList.AddRange(eraseEtos);

　
参考サイト

MicroSoft
List.AddRange メソッド

ゲーマーときどきエンジニア様
【C#】リストにリストを追加するAddRangeメソッドを解説します

GameManager の設定を行う

　新しく変数を３つ追加していますので、そちらの設定を行います。

インスペクター画像

　最下段に追加されていますので、Bomb プレハブのアサインと、ボムの生成に必要な干支のチェーン数、ボムの範囲について設定します。

設定場所

　ツムツムのように７つ以上つなげてボムを生成したい場合には、BombGenerateCount 変数を 6 に設定してください。
これは最初の干支を抜かして、チェーンしている数です。つまり、ゲーム上７つ繋がっている、ということは最初の干支を抜かして、６つがチェーンしている、という解釈です。

Bomb スクリプトを修正する

　GameManager 側にメソッドの準備が整いましたので、TODO 部分を実装します。
また、テスト用に作成しておいた Start メソッドの処理はコメントアウトしておきます。

Bomb.cs

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

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

public class Bomb : MonoBehaviour
{
    private Button btnBomb;

    private float radius;

    [SerializeField]
    private bool onGizmos = true;

    public void SetUpBomb(GameManager gameManager, float bombRadius) {

        if (TryGetComponent(out btnBomb)) {
            btnBomb.onClick.AddListener(() => OnClickBomb(gameManager, bombRadius));
        }
        else {
            Debug.Log("ボムのボタンが取得出来ません");
        }

        // OnDrawGizmos 用
        radius = bombRadius;
    }
    
    /// <summary>
    /// ボムをタップした際の処理
    /// </summary>
    public void OnClickBomb(GameManager gameManager, float bombRadius)
    {
        // TODO SE
       
        List<Eto> eraseEtos = new List<Eto>();
        Collider2D[] colliders = Physics2D.OverlapCircleAll(transform.position, bombRadius);
        
        foreach (Collider2D collider in colliders)
        {
            if (collider.TryGetComponent(out Eto eto))
            {
                eraseEtos.Add(eto);
            }
        }

        // TODO LINQ を利用した場合


////*　TODO を実装する　*////


        // GameManager への干支の削除命令を書く
        if(gameManager != null) {
            gameManager.AddRangeEraseEtolList(eraseEtos);
        }


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


　　　　Debug.Log("ボム実行");

        Destroy(gameObject);
    }


    private void OnDrawGizmos() {

        if (!onGizmos) {
            return;
        }
        
        // コライダーの可視化
        Gizmos.color = Color.red;
        Gizmos.DrawWireSphere(transform.position, radius);
    }

　　//void Start() {

        // デバッグ用のテスト処理
        //SetUpBomb(null, 1.0f);
    //}
}

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

　すべての手順が完成しましたので、実際にゲームを実行して動作を確認します。

　ボムを生成するためには、指定した数の干支をつなげる必要があります。
この指定数を固定で設定しまうと、デバッグがやりにくく、調整する際にもソースコードを直接修正しなければなりません。

　そういった事態を避けるため、今回の設計では GameManager に BombGenerateCount 変数を用意してあります。

　よって、デバッグする際には BombGenerateCount 変数の値を小さくすることで、干支をつなげる数が少なくてもボムが生成されます。
しっかりとソースコードを読み解いてみましょう。

＜ボムの生成＞

動画ファイルへのリンク

＜ボム発動＞

動画ファイルへのリンク

　
　以前の手順でもお伝えしているように、ゲームのデバッグは繰り返し行う前提です。
効率のよい作業をおこなうためにはどうすればいいのかを考えるようにしてみてください。

　ボムの範囲は GameManager の BombRadius 変数で設定できます。
例えば値を変更すれば、すべての干支を破壊するというボムも作れますし、
複数の種類のボムを作り、それぞれの効果範囲を変えるということもできます。

＜すべての干支を削除＞

動画ファイルへのリンク

　ソースコードの内容を読み解くことで応用したプログラムを作成できます。
チャレンジしてみてください。

＜応用　LINQ を利用した処理のリファクタリング＞

　正常にボムの動作することを確認できましたら、Bomb スクリプト内の OnClickBomb 内の処理を LINQ を利用して置き換えてみましょう。

　LINQ の各機能を活用すると、短縮した命令文ですっきりと書けるようになります。
リファクタリングになりますので、既存の処理を置き換えているだけですので、ゲームの見た目や、処理の結果は同じです。

＜置き換える処理＞

        List<Eto> eraseEtos = new List<Eto>();
        Collider2D[] colliders = Physics2D.OverlapCircleAll(transform.position, bombRadius);
        
        foreach (Collider2D collider in colliders)
        {
            if (collider.TryGetComponent(out Eto eto))
            {
                eraseEtos.Add(eto);
            }
        }

　　↓

＜LINQ を利用してリファクタリング＞

        List<Eto> eraseEtos = Physics2D.OverlapCircleAll(transform.position, bombRadius)
            .Select(collider => collider.GetComponent<Eto>())
            .Where(eto => eto != null)
            .ToList();

　LINQ の処理はメソッドチェーンを利用して作成されています。
そのため上記のように、ピリオドの位置で改行することで、各処理を分解して紐解いていくことが出来ます。

　各処理の説明をします。

　Physics2D.OverlapCircleAllは、指定した位置(transform.position)を中心として、指定した半径(bombRadius)内のオブジェクトのコライダーを取得します。
OverlapCircleAllメソッドは、指定した位置に重なっているすべてのコライダーを配列として返します。

　Selectメソッドは、配列内の各要素に対して指定した処理を実行し、結果の要素を新しいコレクションにマッピング(射影)します。
この場合、各colliderからGetComponent<Eto>()を呼び出して、Etoコンポーネントを取得します。
GetComponent<Eto>()は、指定したコンポーネント(Eto)がアタッチされているかどうかを確認し、アタッチされている場合はそのコンポーネントを返します。

　Whereメソッドは、指定した条件(eto != null)に合致する要素のみをフィルタリングします。
この場合、etoがnullでない要素のみを残します。つまり、Etoコンポーネントがアタッチされている要素だけが残ります。
つまり、Select メソッドによって GetComponent した際に、万が一 null の情報があった場合にはそれを除外し、要素の安全性を確保しています。

　ToListメソッドは、コレクションをListに変換します。
この場合、SelectおよびWhereで得られた要素をList<Eto>に変換します。

　以上のような流れにより、最終的に、指定した位置と半径内にあるコライダーを持つオブジェクトの中から、EtoコンポーネントがアタッチされているものだけがeraseEtosリストに追加されます。
リファクタリングする前の処理と同じ内容になります。

GameManager スクリプトを修正する

＜List<T>.AddRange(IEnumerable<T>) メソッド＞

GameManager の設定を行う

Bomb スクリプトを修正する

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

＜応用 LINQ を利用した処理のリファクタリング＞

＜応用　LINQ を利用した処理のリファクタリング＞