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

　前回に引き続き、コルーチンのメソッドと同じ非同期処理である UniTask を利用した非同期処理の実装例です。

子クラスの作成

　こちらも今まで作成した子クラスは利用可能ですので、現在の処理に追記し、
メソッドの実行方法を、コルーチンメソッドの場合と UniTask による場合の両方を記載します。

　親クラスとして GameEventBase クラスを継承しているので、この子クラス自体にも MonoBehaviour クラスの機能を実装出来ます。

　親クラスにて定義している仮想(virtual)メソッドを override しての子クラスにて利用する場合、
修飾子は同じ修飾子で宣言します。今回であれば、親クラスの ExecuteEventCoroutine メソッドを実装しているため、
同じ public 修飾子にて宣言しています。

　この ExecuteEventAsync メソッドは IGameEvent インターフェース内で定義されているメソッドであり、
親クラスである GameEventBase 内で実装されています。今回は ExecuteEventAsync メソッドを仮想(virtual)メソッドとして作成していますので、
今までのコルーチンの ExecuteEventCoroutine メソッドと同じように各子クラスでオーバーライドして実装し、振る舞いを変えることが出来ます。

会話イベント用

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

using System.Collections;
using System.Threading;
using Cysharp.Threading.Tasks;

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

        string npcScenario = GetComponent<NonPlayerCharacter>().npcData.npcScenario;
        
        //NPCシナリオの作成
        yield return StartCoroutine(AdvEngineController.instance.JumpScenarioAsync(npcScenario, null));
        yield return false;
    }


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


    /// <summary>
    /// 非同期
    /// </summary>
    public override async UniTask<bool> ExecuteEventAsync(CancellationToken token) {
        string npcScenario = GetComponent<NonPlayerCharacter>().npcData.npcScenario;

　　　　// 待機処理。この処理が終了するまで、下の処理は実行されない
        await AdvEngineController.instance.JumpScenarioAsync(npcScenario, token);

　　　　// 戻り値として bool 型の値を戻す
        return false;
    }


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


}

　記述の方法が異なりますが、処理の内容自体は同じです。

　またコルーチンのメソッドと違い、UniTask には戻り値の設定ができます。

命令を受ける側の機能の作成

　この部分の処理の流れもいままでと同じです。
ファミコンであれば、ソフトの種類は知らないものの、ファミコンのソフトであれば起動はするというイメージです。
そのため、このクラスのアタッチ先も同じです。

　ただし、実行する変数の型が GameEventBase クラスではなく、IGameEvent 型のインターフェースであれば実行できるように処理を追加してます。
それ以外は同じで、GameEventHandler クラスでは実行する GameEvent の種類は特定しません。
今までと同じように、今回は ExecuteEventAsync メソッドの振る舞いを変えて実行させます。

　UniTask を利用するため、および、前回インポートした Serializable Interface アセットを利用するため、using に３つの宣言を追加します。

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

using System.Collections;
using System.Threading;　　　　　　// 　←　追加します。CancellationToken を使うために必要な namespace です。
using UnityEngine;　　
using Cysharp.Threading.Tasks;　　 // 　←　追加します。UniTask を使うために必要な namespace です。
using TNRD;   　　　　　　　　　　 // 　←　追加します。Serializable Interface を使うために必要な namespace です。

public class GameEventHandler : MonoBehaviour
{
    //[SerializeField] private GameEventBase[] gameEvents;　　　//　そのまま残しておいてもよいですし、コメントアウトでも HideInInspector 属性を付与してもよいです。


    [SerializeField] private SerializableInterface<IGameEvent>[] gameEventInterface;　　//　←　追加します。   

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

        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++;
        }

        yield return isSaveOn;
    }


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


    /// <summary>
    /// 非同期
    /// </summary>
    public async UniTask<bool> ExecuteGameEventsAsync(CancellationToken t) {

        // NPC の MonoBehaviour に紐づくキャンセルトークン作成
        var token = this.GetCancellationTokenOnDestroy();

        int index = 0;
        bool isSaveOn = false;
        
        foreach (var gameEvent in gameEvents) {
            if (!token.IsCancellationRequested) {
                
                // // セーブ可能か確認。こっちでも動くが分かりにくい
                // if (isSaveOn) {
                //     // １つでもセーブ対象になっていれば上書きしない
                //     await gameEvent.ExecuteEventAsync(token);
                // } else {
                //     // まだセーブ対象の処理が存在していない場合、セーブ対象かどうかを実行後に確認
                //     isSaveOn = await gameEvent.ExecuteEventAsync(token);
                // }

                // イベントを実行し、セーブ対象であるかを戻り値で取得
                bool isSaveEvent = await gameEvent.ExecuteEventAsync(token);
                
                // まだセーブ対象のイベントが存在しておらず、かつ、今回のイベントがセーブ対象のイベントの場合
                if (!isSaveOn && isSaveEvent) {
                    // セーブするようにする
                    isSaveOn = isSaveEvent;
                }
                
                // UniTask に戻り値がない場合、キャンセル確認ができる 
                //bool canceled = await gameEvent.ExecuteEventAsync(token).SuppressCancellationThrow();  // キャンセルされたら true を返す
                // if (canceled) {
                //     Debug.Log("キャンセルされた");
                // }
                
                Debug.Log($"イベント {index} : 終了");
                index++;
                
                //Destroy(gameObject);     // タスク中止のデバッグ用
                
                // token の更新のため1フレーム待つ
                await UniTask.Yield(); // token 入れるとここで止まり、結果、移動再開しなくなる
                //Debug.Log(token.IsCancellationRequested);   // タスク中止のデバッグ用
            }
        }

        // セーブの有無を戻す
        return isSaveOn;
    }


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


}

　すでに GameEventHandler クラスがゲームオブジェクトにアタッチされていると思いますので、インスペクターを確認してください。
SerializableInterface<IGameEvent> 型で宣言した GameEventInterface 配列変数がインスペクターに表示されるようになります。

インスペクター画像

　この部分に、今までアサインしていた GameEventBase の代わりに IGameEvent インターフェースを実装しているクラスをアサインしてイベントを実行させます。

　処理の実行内容としては同じ流れですが、実行するまでの処理の記述方法が変わる、という形になります。

UniTask のキャンセル処理

　以前にもお伝えしているように、UniTask (async / await)による非同期処理はゲームオブジェクトに紐づいていません。
非同期処理の実行にゲームオブジェクトが破棄されたとしても、非同期処理自体は停止せず、動き続けます。
よって、UniTask を利用した非同期処理においては、ゲームオブジェクトの破棄のタイミングなどに非同期処理を停止させる処理を施しておく必要があります。

　いくつか方法が用意されていますが、ゲームオブジェクトの破棄のタイミングに紐づいているキャンセルの機能も用意されています。
GetCancellationTokenOnDestroy メソッドがその機能にあたります。このメソッドを実行することでキャンセル処理用の CancellationToken が作成されます。
何回か利用する場合には変数に代入しておき、各非同期処理の実行タイミングで引数として CancellationToken を渡すようにしてください。

　この GetCancellationTokenOnDestroy で作成された CancellationToken は自動的にゲームオブジェクトの破棄のタイミングに紐づいているため、
OnDestroy メソッドなどで手動で非同期処理の停止処理を記述しなくても、ゲームオブジェクトの破棄と同時に非同期処理を停止してくれる機能です。

　// NPC の MonoBehaviour に紐づくキャンセルトークン作成
  var token = this.GetCancellationTokenOnDestroy();

　非同期処理を実行する場合には、必ず CancellationToken を設定するようにしてください。

参考サイト

Light11 様
【Unity】UniTaskのキャンセル処理まとめ・Taskとの比較

命令を受ける側の設定

　すでに作成済のものがあればそれをそのまま利用してください。
　
　GameEventHandler クラスと、会話イベント用の GameEventNpcTalk クラスを NPC 用のゲームオブジェクトにアタッチします。
子クラスが継承している親クラスはアタッチする必要はなく、子クラスのみをアタッチすれば問題ありません。自動的に親クラスの機能も実装されます。

　GameEventHandler クラスがイベントを管理しますので、GameEventInterface 変数に GameEventNpcTalk クラス(この NPC のゲームオブジェクトそのもの)をアサインしてください。

　これでイベントが発火(実行された)したとき、GameEventInterface 変数に登録されている GameEventNpcTalk クラスのメソッドが実行されます。

インスペクター画像(アサイン前)

インスペクター画像(アサイン後)

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

　すでに作成済でのプレイヤー用のゲームオブジェクトにアタッチされている PlayerController クラス、
あるいは分割した PlayerAction クラスと PlayerManager クラスに非同期用のメソッドを追加します。

　最初に PlayerController クラスの修正です。
コルーチンの非同期処理と同じ機能を持つ、UniTask 用の非同期処理を追加します。

　追加内容が多いので、処理をしっかりと読み解いて流れを把握してください。

PlayerController.cs

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


//　新しい変数を３つ追加します。

    [SerializeField] 
    private bool isAsyncSwitch;　　　//　UniTask とコルーチン、どちらの非同期を使うか切り替えるスイッチ役。true = UniTask、false = コルーチン(今までの非同期処理)

    private CancellationTokenSource cancellationTokenSource;
    private CancellationToken token;


    void Start() {
           
　　　　(省略。最後に下記を追加。)

        // Player の MonoBehaviour の破棄と紐づいたキャンセルトークンを作成
        //token = this.GetCancellationTokenOnDestroy();
        cancellationTokenSource = new ();
        token = cancellationTokenSource.Token;
    }

    void Update() {

　　　　(省略。最後に下記を追加。)

        if (Input.GetButtonDown("Action")) {
            // プレイヤーの向いている方向にあるオブジェクトに対してアクションできるか判定

            if (isAsyncSwitch) {
                PrepareJedgeActionAsync(token).Forget();
            } else {
                PrepareJedgeAction();
            }
        }
    }


// 下記の３つのメソッドを最後に追加


    /// <summary>
    /// プレイヤーから投射した Ray が、指定した Layer 設定のあるコライダーに接触したか判定
    /// 接触しており、かつ、該当するオブジェクトの場合にはアクション成功となり、イベント制御開始
    /// </summary>
    private async UniTask PrepareJedgeActionAsync(CancellationToken token) {
        (bool isReadyAction, GameObject hitObj) item = eventChecker.JedgeAction(lookDirection);
        
        if (!item.isReadyAction) {
            return;
        }
        
        // 判定に成功した場合、イベント実行
        await StartEventAsync(item.hitObj, token);
    }


    /// <summary>
    /// UniTask による非同期(Update を async UniTask にしておく)
    /// </summary>
    private async UniTask StartEventAsync(GameObject hitObj, CancellationToken token) {
        
        // イベント開始。移動とアクション停止。
        EnterGameEvent();

        // イベント発生
        await playerAction.PlayActionAsync(hitObj, token);

        // イベント終了。再度移動とアクションを可能にする
        ExitGameEvent();
    }


    /// <summary>
    /// 非同期
    /// </summary>
    /// <param name="hitOject"></param>
    public async UniTask PlayActionAsync(GameObject hitOject, CancellationToken token) {
        
        if (hitOject.TryGetComponent(out NonPlayerCharacter npc) == true) {
            // NPCの向きを変更する
            npc.LookDirection(GetFaceNPC(facePlayer));
        }

        if (hitOject.TryGetComponent(out GameEventHandler gameEventHandler)) {
            
            // NPC のキャンセル処理は NPC 側でキャンセルトークンを作成させる
            CheckSave(await gameEventHandler.ExecuteGameEventsAsync(token));
            
            // こっちでも OK
            //bool isSaveOn = await gameEventHandler.ExecuteGameEventsAsync(token)
            //CheckSave(isSaveOn);
        }
    }
}

　PlayerController クラスを分割済の場合には、
PlayerAction クラスと PlayerManager クラス内に新しい非同期処理を追加します。

PlayerAction.cs

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

using System.Collections;
using System.Threading;　　　　　 //　←　追加します。
using UnityEngine;
using Cysharp.Threading.Tasks;　　//　←　追加します。

public class PlayerAction : PlayerBase
{
    private FacePlayer facePlayer;

    public FacePlayer FacePlayer {
        get => facePlayer;
        set => value = facePlayer;
    }

    public override void SetUpPlayer() {
    }

    /// <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));
        }

        if (hitOject.TryGetComponent(out GameEventHandler gameEventHandler)) {
            IEnumerator eventCoroutine = gameEventHandler.ExecuteGameEventsCoroutine();
            yield return StartCoroutine(eventCoroutine);

            // こっちでも OK
            // bool isSaveOn = (bool)eventCoroutine.Current;
            // CheckSave(isSaveOn);
            
            CheckSave((bool)eventCoroutine.Current);
        }
    }

    /// <summary>
    /// 非同期
    /// </summary>
    /// <param name="hitOject"></param>
    public async UniTask PlayActionAsync(GameObject hitOject, CancellationToken token) {
        
        if (hitOject.TryGetComponent(out NonPlayerCharacter npc) == true) {
            // NPCの向きを変更する
            npc.LookDirection(GetFaceNPC(facePlayer));
        }

        if (hitOject.TryGetComponent(out GameEventHandler gameEventHandler)) {
            
            // NPC のキャンセル処理は NPC 側でキャンセルトークンを作成させる
            CheckSave(await gameEventHandler.ExecuteGameEventsAsync(token));
            
            // こっちでも OK
            //bool isSaveOn = await gameEventHandler.ExecuteGameEventsAsync(token)
            //CheckSave(isSaveOn);
        }
    }

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

    /// <summary>
    /// NPCの向きを伝える
    /// </summary>
    /// <param name="facePlayer"></param>
    /// <returns></returns>
    private FaceNPC GetFaceNPC(FacePlayer facePlayer)
    {
        return facePlayer switch {
            FacePlayer.Back => FaceNPC.FrontNPC,
            FacePlayer.Front => FaceNPC.BackNPC,
            FacePlayer.Left => FaceNPC.RightNPC,
            FacePlayer.Right => FaceNPC.LeftNPC,
            _ => FaceNPC.FrontNPC
        };
    }
}

PlayerManager.cs

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

//　新しい変数を３つ追加します。

    [SerializeField] 
    private bool isAsyncSwitch;　　　//　UniTask とコルーチン、どちらの非同期を使うか切り替えるスイッチ役。true = UniTask、false = コルーチン(今までの非同期処理)

    private CancellationTokenSource cancellationTokenSource;
    private CancellationToken token;


    void Start() {
           
　　　　(省略。最後に下記を追加。)

        // Player の MonoBehaviour の破棄と紐づいたキャンセルトークンを作成
        //token = this.GetCancellationTokenOnDestroy();
        cancellationTokenSource = new ();
        token = cancellationTokenSource.Token;
    }

    void Update() {

　　　　(省略。最後に下記を追加。)

        if (Input.GetButtonDown("Action")) {
            // プレイヤーの向いている方向にあるオブジェクトに対してアクションできるか判定

            if (isAsyncSwitch) {
                PrepareJedgeActionAsync(token).Forget();
            } else {
                PrepareJedgeAction();
            }
        }
    }


// 下記の２つのメソッドを最後に追加


    /// <summary>
    /// プレイヤーから投射した Ray が、指定した Layer 設定のあるコライダーに接触したか判定
    /// 接触しており、かつ、該当するオブジェクトの場合にはアクション成功となり、イベント制御開始
    /// </summary>
    private async UniTask PrepareJedgeActionAsync(CancellationToken token) {
        (bool isReadyAction, GameObject hitObj) item = eventChecker.JedgeAction(lookDirection);
        
        if (!item.isReadyAction) {
            return;
        }
        
        // 判定に成功した場合、イベント実行
        await StartEventAsync(item.hitObj, token);
    }


    /// <summary>
    /// UniTask による非同期(Update を async UniTask にしておく)
    /// </summary>
    private async UniTask StartEventAsync(GameObject hitObj, CancellationToken token) {
        
        // イベント開始。移動とアクション停止。
        EnterGameEvent();

        // イベント発生
        await playerAction.PlayActionAsync(hitObj, token);

        // イベント終了。再度移動とアクションを可能にする
        ExitGameEvent();
    }
}

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

　いままでと同じように NPC に対して会話イベントが発生するかを確認してください。

　完成したら、次の手順で、他の子クラスも UniTask による非同期処理に置き換えた実装例を学習します。

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

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

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

印刷する

コメント（0）

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

コメントをかく

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

i-school