処理の抽象化による実装例④

　イベント処理用の子クラスについてまとめます。

GetGenerator クラスのシングルトン化

　御朱印用のイベントを作成にあたり、GetGenerator クラスを修正します。
いずれのゲームオブジェクトからでも御朱印の獲得演出イベントにアクセスできるように、シングルトンクラスの機能を持たせます。

　このようにすることにより、いくつかの変数が削除できますので、外部クラスとの依存関係が解消出来、
外部からクラスから独立(自立)して責務を果たせるようになります。

GetGenerator.cs

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

using System.Collections;
using UnityEngine;

public class GetGenerator : MonoBehaviour
{
    //private GameManager gameManager;　　　//　削除します

    //御朱印獲得アイコンの管理
    [SerializeField, Header("御朱印獲得アイコン")]
    private GoshuinNotification goshuinNotification;

    //御朱印獲得管理
    [SerializeField, Header("御朱印獲得画面")]
    private PlacementGetPopUp placementGetPopUpPrefab;
    private PlacementGetPopUp placementGetPopUp;

    [SerializeField, Header("スタンプ")]
    private PlacementStampPopUp placementStampPopUpPrefab;
    private PlacementStampPopUp placementStampPopUp;

    [SerializeField, Header("キャンバス")]
    private Transform canvasTran;

    //[SerializeField, Header("プレイヤーコントローラー")]
    //private PlayerController playerController;　　　//　削除します

    //[SerializeField]
    //private GoshuinGenerator goshuinGenerator;　　　//　削除します


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

    /// <summary>
    /// 
    /// </summary>
    /// <param name="gameManager"></param>
    /// <returns></returns>
    public void SetUpGetGenerator()    // GameManager gameManager の引数も不要です
    {
        //this.gameManager = gameManager;　　　//　不要です

        // キャラ配置用のポップアップの生成
        //yield return StartCoroutine(CreatePlacementGetStampPopUp());　　//　通常のメソッドにします

        CreatePlacementGetStampPopUp();　　　//　上記の処理を普通のメソッドの呼び出し命令に変更します
    }

    /// <summary>
    /// 御朱印獲得のポップアップ生成
    /// </summary>
    /// <returns></returns>
    private void CreatePlacementGetStampPopUp()　　　//　処理の内部にコルーチンである必要性が見られないため、通常のメソッドにします
    {
        // placementTelHelpPopUpのポップアップを生成
        placementGetPopUp = Instantiate(placementGetPopUpPrefab, canvasTran, false);
        placementStampPopUp = Instantiate(placementStampPopUpPrefab, canvasTran, false);

        // placementTelHelpPopUpのポップアップの設定。あとでキャラ設定用の情報も渡す
        placementGetPopUp.SetUpPlacementGetPopUp(this);
        placementStampPopUp.SetUpPlacementStampPopUp(this);

        // placementTelHelpPopUpのポップアップを非表示にする
        placementGetPopUp.gameObject.SetActive(false);
        placementStampPopUp.gameObject.SetActive(false);

        //yield return null;　　//　削除します
    }

    /// <summary>
    /// 御朱印獲得のポップアップの表示
    /// </summary>
    public void ActivatePlacementGetStampPopUp(GoshuinData goshuinData)
    {
        StartCoroutine(ActivatePlacementGetStampPopUp2(goshuinData));
    }

    /// <summary>
    /// 御朱印獲得のポップアップの非表示
    /// </summary>
    public void InActivateGetGoshuinPopUp()
    {
        placementGetPopUp.gameObject.SetActive(false);
        placementStampPopUp.gameObject.SetActive(false);
    }

    public IEnumerator ActivatePlacementGetStampPopUp2(GoshuinData goshuinData)
    {
        //playerController.StopPlayer();　　　　　　//　プレイヤーの移動制御は PlayerController 側で行っていますので不要です

        placementGetPopUp.DisplayGoshuin(goshuinData);
        placementStampPopUp.DisplayStamp(goshuinData);
        placementGetPopUp.gameObject.SetActive(true);

        yield return new WaitForSeconds(2);

        placementStampPopUp.StampAction(goshuinData);

        //placementGetGoshuinStampPopUp.gameObject.SetActive(true);


        yield return new WaitForSeconds(2);
        placementGetPopUp.gameObject.SetActive(false);
        placementStampPopUp.gameObject.SetActive(false);

        //Newアイコンをオンにする
        goshuinNotification.ActiveGetGoshuinIconPopUp();

        //御朱印ジェネレーターを更新させる
        //goshuinGenerator.CreateHaveGoshuinDatasList2();

        yield return new WaitForSeconds(1);

        //playerController.NonStopPlayer();　　　　　//　プレイヤーの移動制御は PlayerController 側で行っていますので不要です
    }
}

　スクリプトを修正したらセーブします。
どの部分を改良したのか確認しておくようにし、処理への理解を深めてください。

新しいイベント用の子クラスの作成

　分岐処理内で作成していたイベント処理を、子クラスにしてイベント化します。

１．御朱印用のオブジェクトの獲得イベント用(シーンでオブジェクトから取得するイベント)

　シーン内に設置されている御朱印を獲得した際のイベントです。

　イベントの中で取得する方法ではなく、オブジェクトとして取得するタイプのイベント用のクラスです。

GameEventGoshuinBox.cs

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

using System.Collections;
using UnityEngine;

public class GameEventGoshuinBox : GameEventBase
{
    [SerializeField]
    private GoshuinName goshuinName;     //御朱印の有無

    public void SetUpGoshuin()
    {
        // デバッグ用
        // DataBaseManager に登録してあるスクリプタブル・オブジェクトを検索し、指定した通し番号の EventData を NPC 用の EventData として取得して代入
        //Debug.Log("SetUpGoshuin" + gosSeachEventNo);
        //goshuinData = DataBaseManager.instance.GetGoshuinDataFromGoshuinNo(gosSeachEventNo);
        //CheckPossesion();
        //this.gameObject.SetActive(true);
    }

    /// <summary>
    /// 所持しているかどうかの判定
    /// </summary>
    public void CheckPossesion()
    {
        for (int i = 0; i < DataBaseManager.instance.goshuinDataSO.goshuinDatasList.Count; i++)
        {
            if (DataBaseManager.instance.goshuinDataSO.goshuinDatasList[i].goshuinName == goshuinName)
            {
                Debug.Log("左：" + DataBaseManager.instance.goshuinDataSO.goshuinDatasList[i].goshuinName);
                Debug.Log("右：" + goshuinName);
                this.gameObject.SetActive(false);
            }
            else
            {
                Debug.Log(goshuinName + "：その御朱印は持っていないから消さないよ");
                this.gameObject.SetActive(true);
            }
        }
    }
    
    /// <summary>
    /// コルーチンによる非同期
    /// </summary>
    /// <returns></returns>
    public override IEnumerator ExecuteEventCoroutine() {
        
        // 御朱印がNoData出なければ、御朱印を追加する
        if (!GameData.instance.goshuinInventryDatasList.Exists(x => x.goshuinName == goshuinName)) {

            yield return StartCoroutine(GetGenerator.instance.ActivatePlacementGetStampPopUp2(DataBaseManager.instance.GetGoshuinDataFromName(goshuinName)));

            GameData.instance.AddGoshuinInventryData(goshuinName);

　　　　　　// 戻り値を true (セーブ有り)で保持
　　　　　　// ゲームオブジェクトを非アクティブにする前に、先に return しておかないと Current で戻り値を取得できない
            yield return true;

            gameObject.SetActive(false);  

　　　　　　// ここで処理終了(↓の処理にはいかない)
            yield break;
        }

　　　　// 戻り値を false (セーブなし)で保持
　　　　// ゲームオブジェクトを非アクティブにする前に、先に return しておかないと Current で戻り値を取得できない
        yield return false;

        gameObject.SetActive(false);
    }
}

２．御朱印の取得イベント用

　オブジェクト以外からの御朱印の取得イベント用です。
会話イベントなどと組み合わて使うことを想定しています。

　ここからはコメントの補記を省略しています。
いままでの子クラス内部の処理を見直し、自分でコメントを補記してみてください。

GameEventGetGoshuin.cs

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

using System.Collections;
using UnityEngine;

public class GameEventGetGoshuin : GameEventBase
{
    [SerializeField]
    private GoshuinName goshuinName;     //御朱印の有無
    
    
    /// <summary>
    /// コルーチンによる非同期
    /// </summary>
    /// <returns></returns>
    public override IEnumerator ExecuteEventCoroutine() {
        
        // 今回終了した会話イベント後に紐づいたイベントがあるか確認
        if (!AdvEngineController.instance.AdvEngine.Param.GetParameterBoolean(utageParamBoolName.ToString())) {

            Debug.Log("対象のイベントではない");

            yield return false;

            yield break;
        }

        // 御朱印がNoData出なければ、御朱印を追加する
        if (!GameData.instance.goshuinInventryDatasList.Exists(x => x.goshuinName == goshuinName)) {

            yield return StartCoroutine(GetGenerator.instance.ActivatePlacementGetStampPopUp2(DataBaseManager.instance.GetGoshuinDataFromName(goshuinName)));

            GameData.instance.AddGoshuinInventryData(goshuinName);

            yield return true;
        }
    }
}

３．自動移動イベント用

　オブジェクトの自動移動イベント用のクラスです。
単独でもよいですし、他のイベントと組わ合わせても利用できます。

　DOTween はコルーチン内部で実行する場合、yield return 付で命令することが出来ます。
その場合、WaitForCompletion() メソッドをチェーンすることで待機処理として実行されます。

GameEventAutoMove.cs

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

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

public class GameEventAutoMove : GameEventBase
{
    private BoxCollider2D boxCollider2D;
    private Animator anim;
    private Vector3[] paths;
    
    [SerializeField, Header("移動経路の情報")]
    private PathData pathData;
    
    [SerializeField, Header("移動速度")]
    private float moveSpeed = 30.0f;


    public override IEnumerator ExecuteEventCoroutine() {
        
        // UTAGE のフラグ確認が必要？
        // 今回終了した会話イベント後に紐づいたイベントがあるか確認
        // if (!AdvEngineController.instance.AdvEngine.Param.GetParameterBoolean(utageParamBoolName.ToString())) {
        //     Debug.Log("対象のイベントではない");
        //     return;
        // }

        if (!TryGetComponent(out boxCollider2D)) {
            Debug.Log("Box Collider 取得できないため、処理を終了します");
            yield return false;
            yield break;
        }

        // isTriggerをOnにする。 
        boxCollider2D.isTrigger = true;

        paths = pathData.pathTranArray.Select(x => x.position).ToArray();

        // 移動
        yield return transform.DOPath(paths, moveSpeed)
            .SetEase(Ease.Linear)
            .OnWaypointChange(ChangeAnimeDirection)
            .WaitForCompletion();

        boxCollider2D.isTrigger = false;
        yield return false;
    }

    /// <summary>
    /// キャラの向き変更
    /// </summary>
    /// <param name="index"></param>
    private void ChangeAnimeDirection(int index)
    {
        Debug.Log(index);
        // 次の移動先の地点がない場合には、ここで処理を終了する
        if (index >= paths.Length)
        {
            return;
        }
        
        if (!TryGetComponent(out anim)) {
            Debug.Log("Animator 取得できないため、処理を終了します");
            return;
        }
    
        if (transform.position.x > paths[index].x)
        {
            anim.SetFloat("Y", 0f);
            anim.SetFloat("X", -1.0f);
            Debug.Log("左方向");
        }
    
        if (transform.position.y < paths[index].y)
        {
            anim.SetFloat("Y", 1.0f);
            anim.SetFloat("X", 0f);
            Debug.Log("上方向");
        }
    
        if (transform.position.y > paths[index].y)
        {
            anim.SetFloat("Y", -1.0f);
            anim.SetFloat("X", 0f);
            Debug.Log("下方向");
        }
    
        else
        {
            anim.SetFloat("Y", 0f);
            anim.SetFloat("X", 1.0f);
            Debug.Log("右方向");
        }
    }
}

４．オブジェクトの自動生成イベント用

　オブジェクトの自動生成イベント用のクラスです。

　今回は NonPlayerCharacter 型で生成していますが、これも抽象化を利用すれば他のゲームオブジェクトも生成対象に出来ます。

GameEventGenerateChara.cs

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

using System.Collections;
using UnityEngine;
using UnityEngine.UI;

public class GameEventGenerateChara : GameEventBase
{
    [SerializeField]
    private NonPlayerCharacter nonPlayerCharacterPrefab;

    [SerializeField] 
    private Transform generateTran;

    [SerializeField]
    private bool isOnlyEvent;   // 一度生成したら終わりにする
    
    
    /// <summary>
    /// コルーチンによる非同期
    /// </summary>
    /// <returns></returns>
    public override IEnumerator ExecuteEventCoroutine() {
        
        if (isOnlyEvent) {
            Debug.Log("オブジェクト生成済");
            yield return false;
            yield break;
        }
        
        // 今回終了した会話イベント後に紐づいたイベントがあるか確認
        if (!AdvEngineController.instance.AdvEngine.Param.GetParameterBoolean(utageParamBoolName.ToString())) {
            Debug.Log("対象のイベントではない");
            yield return false;
            yield break;
        }

        if (!generateTran) {
            // 生成位置の登録がない場合、エラーになるのを防ぐため、このクラスのゲームオブジェクトの情報を代入
            generateTran = transform;
        }

        // 生成
        NonPlayerCharacter npc = Instantiate(nonPlayerCharacterPrefab, generateTran.position, Quaternion.identity);
        npc.SetUpNPC();
        isOnlyEvent = true;

        yield return false;
    }
}

イベントの作成方法

　こちらは前回までと同じです。

　GameEventHandler クラスをイベントを発火させたいゲームオブジェクトにアタッチし、
合わせて、そのゲームオブジェクトに実際に発火するイベントのクラスをアタッチします。

　アタッチする順番は順不同です。アサインの順番だけイベント順に並べてください。

御朱印の場合

Scene ビュー画像

インスペクター画像

会話＋御朱印＋移動など複数のイベントの組み合わせの場合

Scene ビュー画像

インスペクター画像

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

　作成したイベントをまとめて試す前に、まずは、１つずつのイベントが正常に実行されるか確認してください。
いきなりまとめて試してしまうと、万が一バグが発生した場合、どの部分に問題があるのか分からないためです。

　こういった機能をまとめて試す前に、１つずつイベントが動作することを確認してから
複数のイベントが実行されることを確認していくことが鉄則です。

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

　次以降の手順は非同期処理の追加学習です。
コルーチンではなくて async / await という非同期用の機能と、それを助けるアセットである UniTask を利用して
コルーチンで作成した待機処理を、別の形での非同期処理にして実装を行います。

　次の手順は　処理の抽象化による実装例⑤　です。

このページを編集するこのページを元に新規ページを作成

印刷する

コメント（0）

処理の抽象化による実装例④ - i-school 先頭へ

コメントをかく

名前	ユーザIDを使用しないで書き込む	ユーザーIDを使う	ログインする
画像コード	画像に記載されている文字を下のフォームに入力してください。
備考	「http://」を含む投稿は禁止されています。
本文
利用規約をご確認のうえご記入下さい

i-school