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

　前回作成した機能を拡張し、複数のイベントを順番に制御するイベント処理の実装例です。

　この機能も処理の抽象化を活用することにより実装が可能です。

＜実装動画　宝箱のイベントが終了してから、オブジェクト生成イベントが順番に実行される＞

　アサインした GameEvent によりイベントの順番が制御できます。

　そのため、アサインする順番を逆にすることで、オブジェクト生成→宝箱の順にイベント制御が可能です。

＜実装動画　オブジェクト生成イベントが終了してから、宝箱のイベントが順番に実行される＞

動画ファイルへのリンク

＜学習内容＞

　・コルーチンの内部から戻り値のように値を取り出す方法

設計

　親クラスである GameEventBase クラスをそのまま活用し、子クラスを新規作成してイベントの処理を作成してきます。
現在は会話イベント用のクラスを作成していますが、他の分岐処理の部分も１つずつイベント化(子クラス化)していきます。

　GameEvent を実行している GameEvetHandler クラスを修正し、１つしか登録できない GameEvent 変数を配列に変更し、
複数の GameEventBase クラスをアサインして登録出来るようにします。

　それに合わせて、現在は１回しか実行していない GameEvent の実行命令を修正し、
登録している GameEvent を上から順番に実行していくように修正します。

インスペクター画像例

　またインスペクターにある配列の情報はドラッグアンドドロップで並び替えができます。
そのため、この部分を変更するだけで、イベント処理の実行順を変えることが出来ます。
これは新しい子クラスを作成しても同様です。

イベント実行順の変更

動画ファイルへのリンク

　このような設計になっているため、イベントの順番を変えるためにスクリプトへの処理の変更は必要ありません。

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

　前回作成した GameEventNpcTalk クラスと同じように、イベントにつき１つのクラスを作成します。

　ここではアイテム取得関連のイベントを２つ記載します。

１．宝箱のイベント用

　前回作成済の子クラスは引き続き利用できますので、ここでは他の子クラスを作成します。
いずれも親クラスである GameEventBase クラスを継承した子クラスを作成します。

　そして GameEventNpcTalk クラスと同じように、親クラスの ExecuteEventCoroutine メソッドをオーバーライドして
それぞれのイベントの処理を記述します。宝箱であれば、宝箱を開けた際の処理を記述します。

　ここでは既存の TreasureBox クラスを元に新しい子クラスを作成し、イベント機能に対応させています。
クラスの命名規則はありませんが、GameEvent ～という形で統一すると、イベント用のクラスであることが分かりやすくなります。

GameEventTreasureBox.cs

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

using System.Collections;
using UnityEngine;

public class GameEventTreasureBox : GameEventBase　　//　←　GameEventBase を継承させる
{
    [Header("探索イベント判定用")]
    public bool isOpen;         // true の場合は会話イベント中であるように扱う

    [SerializeField]
    private int itemNo;
    
    private ItemData itemData;

    [SerializeField, Header("空いた時の画像")]
    private Sprite openSprite;

    // - アイコンの設定 - 

    [SerializeField, Header("アイコン")]
    private PlacementIconPopUp placementIconPopUpPrefab;
    private PlacementIconPopUp placementIconPopUp;

    [SerializeField]
    private Transform canvasTran;

    private SpriteRenderer spriteRenderer;
    
    
    /// <summary>
    /// デバッグ用
    /// </summary>
    public void Start()
    {
        SetUpTresureBox();
    }

    public void SetUpTresureBox()
    {
        isOpen = false;
        TryGetComponent(out spriteRenderer);

        //spriteRenderer = GetComponent<SpriteRenderer>();

        // 対象物 の EventData を取得
        itemData = DataBaseManager.instance.GetItemDataFromItemNo(itemNo);
        
        // 所持しているかどうかの判定
        CheckPossesion();

        //アイコン の 設定
        CreatePlacementIconPopUp();
    }

    /// <summary>
    /// 所持しているかどうかの判定
    /// </summary>
    public void CheckPossesion()
    {
        Debug.Log("アイテムの保有数：" + GameData.instance.itemInventryDatasList.Count);
        for (int i = 0; i < GameData.instance.itemInventryDatasList.Count; i++)
        {
            if (GameData.instance.itemInventryDatasList[i].itemName == itemData.itemName)
            {
                Debug.Log(itemData.itemName + "：そのアイテムは持っているから消すよ");
                Destroy(this.gameObject);
            }
            else
            {
                Debug.Log(itemData.itemName + "：そのアイテムは持っていないから消さないよ");
            }
        }
    }

    /// <summary>
    /// 配置キャラ選択用ポップアップ生成
    /// </summary>
    /// <returns></returns>
    public void CreatePlacementIconPopUp()
    {
        // placementIconPopUpのポップアップを生成
        placementIconPopUp = Instantiate(placementIconPopUpPrefab, canvasTran, false);

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

    /// <summary>
    /// Iconの表示
    /// </summary>
    /// <param name="collision"></param>
    private void OnCollisionEnter2D(Collision2D collision)
    {
        if (isOpen) {
            return;
        }
        
        if (collision.gameObject.tag == "Player")
        {
            placementIconPopUp.gameObject.SetActive(true);
        }
    }

    /// <summary>
    /// Iconの非表示
    /// </summary>
    /// <param name="collision"></param>
    private void OnCollisionExit2D(Collision2D collision)
    {
        if (collision.gameObject.tag == "Player")
        {
            placementIconPopUp.gameObject.SetActive(false);
        }
    }

    /// <summary>
    /// イベント処理
    /// </summary>
    /// <returns></returns>
    public override IEnumerator ExecuteEventCoroutine() {　　　//　←　親クラスのメソッドをオーバーライド

　　　　// UTAGE のアイテム取得用の会話イベントを実行
        yield return StartCoroutine(AdvEngineController.instance.JumpScenarioAsync(itemData.itemScenario, null));

　　　　// アイテムの獲得
        bool isSaveEvent = SwitchStateTresureBox();

　　　　// セーブの可否を戻り値として保持
        yield return isSaveEvent;
    }

    /// <summary>
    /// 探索状態の切り替え
    /// </summary>
    private bool SwitchStateTresureBox() {

        // 既にisOpenがtrueの時ならば何もしない（returnで返す）。
        if (isOpen) {

　　　　　　// 戻り値をセーブなしとして戻す
            return false;
        }

        // isOpenがfalseの時に限り、以下の処理を行う。

　　　　// 開封済みにして絵を差し替え、！マークを消す
        isOpen = true;
        spriteRenderer.sprite = openSprite;
        placementIconPopUp.gameObject.SetActive(false);
        
　　　　// アイテムの情報を追加
        GameData.instance.AddItemInventryData(itemData.itemName);

　　　　// 戻り値をセーブ有として戻す
        return true;
    }
}

２．宝箱以外からのアイテムの取得用

　宝箱を通さずにアイテムを入手するようなケースのイベント処理です。
そのためこれは会話イベントなどと組み合わせて使うことを想定しています。

GameEventGetItem.cs

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

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

public class GameEventGetItem : GameEventBase
{
    [SerializeField]
    private ItemName itemName;
    
    
    /// <summary>
    /// コルーチンによる非同期
    /// </summary>
    /// <returns></returns>
    public override IEnumerator ExecuteEventCoroutine() {  //  ←　親クラスのメソッドをオーバーライド

        // すでに所持しているアイテムの場合、セーブ処理の対象にはせず、獲得処理もしない
        if (GameData.instance.itemInventryDatasList.Exists(x => x.itemName == itemName)) {

　　　　　　// 戻り値を false (セーブなし)で保持
            yield return false;

            // ここで処理終了(↓の処理にはいかない)
            yield break;
        }
        
        // 今回終了した会話イベント後に紐づいたイベントがあるか確認
        if (AdvEngineController.instance.AdvEngine.Param.GetParameterBoolean(utageParamBoolName.ToString())) {
            GameData.instance.AddItemInventryData(itemName);

　　　　　　// 戻り値を true (セーブ有)で保持
            yield return true;

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

　　　　// 戻り値を false (セーブなし)で保持
        yield return false;
    }
}

　長くなるため、他の子クラスについては別のページにまとめて置きます。

命令を受ける側の機能の修正

　最初に説明があったように、GameEventHandler クラスを修正し、複数の GameEventBase クラスを登録できるようにした上で、
登録した順番通りに１つずつ GameEvent が実行できるように処理を修正します。

　元からあるメソッドを修正してもよいのですが、メソッドの内容をほぼ書き換えることになるため、
新しい変数とメソッドを作成して対応します。

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

using System.Collections;
using UnityEngine;

public class GameEventHandler : MonoBehaviour
{
    [SerializeField, HideInInspector] private GameEventBase gameEvent;　　//　←　HideInInspector 属性を追加し、インスペクターには見えないようにします。


////*　新しい変数を１つ宣言する　*////


    [SerializeField] private GameEventBase[] gameEvents;　　//　配列なので変数名は複数形にします


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


    /// <summary>
    /// コルーチンによる非同期処理。プレイヤー側から実行される、イベントの起動処理。
    /// </summary>
    /// <returns></returns>
    public IEnumerator ExecuteGameEventsCoroutine() {

        yield return StartCoroutine(gameEvent.ExecuteEventCoroutine());　　　//　イベントを起動する
            
　　　　Debug.Log("イベント 終了");
    }


////*　新しいメソッドを１つ追加　*////


    /// <summary>
    /// コルーチンによる非同期
    /// </summary>
    /// <returns></returns>
    public IEnumerator ExecuteGameEventsCoroutine() {

　　　　//　デバッグ用の管理数字。何回処理が行われているかをカウントする(foreach 文は for 文と違い、カウント回数は取得できないため)
        int index = 0;

　　　　// いずれ実装するセーブ可否用のフラグの準備
        bool isSaveOn = false;
　
　　　　// 登録されているイベントを１つずつ取り出す
        foreach (var gameEvent in gameEvents) {

　　　　　　// イベントをラップして(変数に代入して)実行する
            IEnumerator gameEventCoroutine = gameEvent.ExecuteEventCoroutine();

　　　　　　// イベントの起動(実行)。このイベントが終了するまで処理は待機し、次のイベントは実行されないことを保証する
            yield return StartCoroutine(gameEventCoroutine);
            
            // このフラグを入れないと、一度 true になったあとに false に戻される可能性がある
            if (!isSaveOn && gameEventCoroutine.Current != null) {

　　　　　　　　// コルーチン内部から戻り値を取得するテクニック
                isSaveOn = (bool)gameEventCoroutine.Current;
            }

            Debug.Log($"イベント {index} : 終了");

　　　　　　// イベントが終わった回数をカウント
            index++;
        }

　　　　// このコルーチンの戻り値の設定。Current で取得できる
        yield return isSaveOn;
    }


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


}

　処理の内容が難しいため、１つずつ、どのような処理を行っているのかを調べながら学習し、復習しながら覚えてください。

＜コルーチンの内部から戻り値のように値を取り出す方法＞

　コルーチンメソッドの戻り値の型は IEnumerator インターフェースです。こちらは変更することが出来ません。

　そのため通常のメソッドのように戻り値の型を指定し、メソッドから戻り値を受け取ることが出来ません。

　ただし、IEnumerator インターフェースには object 型の Current プロパティが用意されています。

System.Collections.IEnumerator インターフェースの定義

namespace System.Collections
{
    public interface IEnumerator
    {
        object Current { get; }

        bool MoveNext();

        void Reset();
    }
}

　この Current プロパティには yield return 処理を利用することで情報を代入しておくことが出来ます。

　下記の GameEventGetItem クラス内のメソッドでは３箇所で利用されています。

    /// <summary>
    /// コルーチンによる非同期
    /// </summary>
    /// <returns></returns>
    public override IEnumerator ExecuteEventCoroutine() {

        // すでに所持しているアイテムの場合、セーブ処理はせず、獲得処理もしない
        if (GameData.instance.itemInventryDatasList.Exists(x => x.itemName == itemName)) {
            yield return false;　　//　←　ここ
            yield break;
        }
        
        // 今回終了した会話イベント後に紐づいたイベントがあるか確認
        if (AdvEngineController.instance.AdvEngine.Param.GetParameterBoolean(utageParamBoolName.ToString())) {
            GameData.instance.AddItemInventryData(itemName);

            yield return true;　　//　←　ここ
            yield break;
        }

        yield return false;　　　//　←　ここ
    }

　これは他のイベント用の子クラスにも用意されています。

　いずれも bool 値を yield return で Current に代入して保持していますが、
この値を代入しているタイミングがポイントです。

　この値はセーブの可否として利用するために用意されています。
そのため、セーブの可否判定が決定したタイミングで true / false を代入しています。

　この Current の機能を活用し、IEnumerator インターフェース型の変数を用意し、この中にコルーチンメソッドの処理を代入します。

　その後、この代入されている変数を使ってコルーチンメソッドを実行します。
このように通常のメソッド処理をそのまま実行するのではなく、一度、別の変数に入れて、
その変数を使って代入されているメソッドを実行することをラップ処理といいます。

　変数を通じてコルーチンメソッドを実行し、その内部にして yield return 処理することにより、
object 型の情報としての情報として Current プロパティに値が代入されて保持されます。
この値を取り出すことで疑似的なコルーチンメソッドの戻り値として活用することが出来ます。

　　　　　　// イベント処理用のコルーチンメソッドを変数に代入(ラップする)
            IEnumerator gameEventCoroutine = gameEvent.ExecuteEventCoroutine();

　　　　　　// イベントの起動(実行)。このイベントが終了するまで処理は待機し、次のイベントは実行されないことを保証する
            yield return StartCoroutine(gameEventCoroutine);
            
            // このフラグを入れないと、一度 true になったあとに false に戻される可能性がある
            if (!isSaveOn && gameEventCoroutine.Current != null) { 

　　　　　　　　// コルーチン内部から戻り値を取得するテクニック
                isSaveOn = (bool)gameEventCoroutine.Current;  //  ←　ここでコルーチンメソッド内の Current プロパティからメソッド内の情報を取り出している
            }

　Current プロパティは object 型です。そのため、利用したい型に型変換(キャスト)する必要があります。

　ここではコルーチンメソッド内で true / false の値を yield return しているので、
その情報を object 型で取りだしてから (bool) を利用して 0bject → bool に型変換して利用しています。

　今回のプログラムの場合、すべてのイベント処理内で、yield return の処理を行い、true / false の値を Current に保持しています。
各子クラスの処理を見直してみてください。

　そしてその情報をイベントを実行した後で確認し、今回実行したイベントにおいて、
セーブが必要になったのか、あるいは不要なのかをフィードバックさせるための機能として役立てています。

　このような形で、実行したイベントからセーブ可否のフィードバックの仕組みを作ることにより、セーブが必要な時にだけセーブを行うような構造にしています。

参考サイト

【ハルシオンブログ】様
Unityのコルーチンで値を返す方法。いくつか方法あるぽいけど、その一つを紹介。

命令を実行する側の機能の修正

　PlayerController クラスの PlayActionCoroutine メソッド内にあるイベントを実行する処理を変更します。

　いままでは GameEventHandler クラスの GameEvent を１つだけ実行していましたが、
この部分を新しく作成した複数の GameEvent を実行するためのメソッドの呼び出しに変更します。

PlayerController.cs
＜修正＞

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

    /// <summary>
    /// コルーチンによる非同期イベント実行
    /// </summary>
    /// <param name="hitOject"></param>
    /// <param name="facePlayer"></param>
    /// <returns></returns>
    public IEnumerator PlayActionCoroutine(GameObject hitOject) {

        if (hitOject.TryGetComponent(out NonPlayerCharacter npc) == true) {
            // NPCの向きを変更する
            npc.LookDirection(GetFaceNPC(facePlayer));
        }

　　　　// 各クラスを判定するのではなく、イベントを発生させる GameEventHandler がアタッチされているかだけを判定する
        if (hitOject.TryGetComponent(out GameEventHandler gameEventHandler)) {


////*　ここから修正　*////


　　　　　　// ここでも、GameEventHandler に登録されているイベントを実行する、ことだけやっている
            //     → どんなイベントを実行しているかは、ここでは知らない
            //gameEventHandler.ExecuteGameEventCoroutine();　　//　←　コメントアウト


　　　　　　// GameEventHandler に登録されているすべてのイベントを実行する、ことだけやっている
            //     → どんなイベントを実行しているかは、ここでは知らない
            IEnumerator eventCoroutine = gameEventHandler.ExecuteGameEventsCoroutine();　　//　←　追加
            yield return StartCoroutine(eventCoroutine);　　　　　　　　　　　　　　　　　 //　←　追加

            // セーブの有無判定の実装
            bool isSaveOn = (bool)eventCoroutine.Current;
            CheckSave(isSaveOn);


            // 上記2行分を１行で書いた場合          
            CheckSave((bool)eventCoroutine.Current);


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


        }
    }

　またセーブの可否を確認して、セーブを行うためのメソッドを追加します。

　ここでは、イベントの内容によってセーブの可否を戻り値として受け取っておき、
その状態を確認してから、必要に応じてセーブを行います。

　PlayerController クラス内であればメソッドの追加場所はどこでも構いません。

PlayerController.cs
＜追加＞

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

    /// <summary>
    /// セーブ確認
    /// </summary>
    /// <param name="isSaveOn"></param>
    private void CheckSave(bool isSaveOn) {
        if (!isSaveOn) {
            return;
        }
        GameData.instance.SaveAllUserDatas();
    }

イベントの作成方法

　GameEventHandler クラスをイベントを発火させたいゲームオブジェクトにアタッチし、
合わせて、そのゲームオブジェクトに実際に発火するイベント用の子クラスをアタッチします。
　
　アタッチする子クラスの順番は順不同です。
ただし、GameEvents 変数にアサインしている順番にイベントが実行されますので、アサイン順には注意してください。

　宝箱のオブジェクトに、宝箱からアイテムの入手イベントとキャラの自動生成イベントをセットしている場合には、次のようになります。

インスペクター画像例

　その前、まずはイベントのデバッグを行います。

イベントの挙動確認とエラー対策

　実際に複数のイベントを起動させる前に、まずは、１つずつ順番にアサインしてイベント処理が正常に動作するかを確認してください。
その際、空っぽのアサイン場所は削除してください。

　現在のプログラムではイベントの null チェックをしていないので、いずれかの要素(Element)に空っぽのアサイン場所があるとエラーが出ます。
配列にはアサインがある前提です。

エラーになる場合①

エラーになる場合②

エラーになる場合③

エラーになる場合④

正常に１つずつ動作検証する場合

　どうすればエラーにならないのか、エラーになってしまう理由はなんなのか、ということも
プログラムを読み解いていくことで理解が深まり、対処方法が学習出来ます。

　特に自作する場合、どのようなエラーが発生しうるのか、自分で理解しておかなければ適切な処理が書けません。

　折角ですので、エラー対策も考えてみてください。
どのクラスに、どのような処理を施せばいいのか、プログラムを見ながら考えてみてください。

＜回答例＞

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

GameEventHandler.cs

    /// <summary>
    /// コルーチンによる非同期
    /// </summary>
    /// <returns></returns>
    public IEnumerator ExecuteGameEventsCoroutine() {
        int index = 0;
        bool isSaveOn = false;
        foreach (var gameEvent in gameEvents) {


            // GameEvent が空なら、この処理は終了して、次の foreach の処理に行く
            if (gameEvent == null) {
                continue;
            }

            
            IEnumerator gameEventCoroutine = gameEvent.ExecuteEventCoroutine();
            yield return StartCoroutine(gameEventCoroutine);

            (省略)

    }

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

　正常に動作することを確認できたら、GameEvents 変数に２つ以上のイベントをアサインしてください。
GameEvents 変数にアサインしている順番にイベントが実行されますので、実行して確認してください。

　前のイベントが終了するまでは次のイベントは発生しません。
また、プレイヤーの移動操作も出来ません。

　そのような挙動になっているかを確認してください。

＜実装動画　宝箱のイベントが終了してから、オブジェクト生成イベントが順番に実行される＞

動画ファイルへのリンク

　アサインした GameEvent によりイベントの順番が制御できます。
逆にして、オブジェクト生成→宝箱のイベントになるか、確認してください。

インスペクター画像(GameEvents 変数へのアサインの順番を変える)

＜実装動画　オブジェクト生成イベントが終了してから、宝箱のイベントが順番に実行される＞

動画ファイルへのリンク

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

　イベント用の子クラスのサンプルは次の手順にあります。

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

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

印刷する

コメント（0）

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

コメントをかく

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

i-school