UniRx の購読停止と再購読の実装例②

　UniRx の購読処理は非同期処理であるため、変数自体を null にしても停止しません。
明示的に手動で Dispose するか、あるいは AddTo メソッドを利用してゲームオブジェクトやクラスの破棄のタイミングで停止するようにセットする必要があります。

　ここでは、ゲームの途中(ランライム中)における購読の停止処理、および、再購読の実装例を提示します。

購読処理の停止について

購読処理の停止の設計

　Start メソッドなどを利用して Subscribe している処理について、ゲーム内で停止させる場合には、
現在動いている購読処理を停止したいタイミングで Dispose する必要があります。

　性質上、Subscribe している変数の値を null にしたとしても、動いている購読の処理は停止しません。
これは UniRx が非同期で実行されている処理になるためであり、ゲームオブジェクトが破棄されても購読が自動停止しないようになっているためです。
そのため、ゲームオブジェクトの破棄のタイミングで購読を停止させる AddTo メソッドが用意されています。
なお、コルーチンの処理の場合は自動的にゲームオブジェクトの破棄に紐づいているため、非同期処理ではありますが、自動的に停止します。
　

IDisposable インターフェース

　AddTo メソッドを利用せず(ゲームオブジェクトやクラスを破棄する以外のタイミングで) Dispose を実行するためには
IDisposable 型の変数を用意しておいて、その中に Subscribe している処理を代入しておきます。

　これは、Subscribe の戻り値が IDisposable 型であることを利用した処理になります。

＜例＞

using System;
using UniRx;

public class TestDisposable {

    private IDisposable subscription;
    public ReactiveProperty<int> Hp = new(0);

    void Start() {
        subscription = Hp.Subscribe(value => Debug.Log(value));
    }
}

　IDisposable 型は System の namespace に含まれているインターフェースです。
そのため、利用する場合には using での宣言、あるいは namespace を付けた型の宣言が必要です。

＜using での宣言＞

  using System;

  IDisposable disposable;

＜namespace を付けた型の宣言＞

  private System.IDisposable disposable;

　また UniRx には、IDisposable インターフェースを実装している SingleAssigenmentDisposable 型もありますので、そちらも利用できます。
こちらは UniRx に含まれているため、System の宣言不要で利用できます。クラスのため new して(インスタンスを作成して)利用します。

  private SingleAssignmentDisposable disposable = new();

　このようにして、 Subscribe の戻り値の情報(購読している処理)を代入しておくための変数を用意しておくことで、
任意のタイミングでこの変数を使って、Subscribe している購読処理を Dispose し、停止出来ます。

　DOTween も同様ですが、一度動き出した非同期処理には後から手を出すことは出来ません。
そのため、メソッド実行時に、処理自体を変数に代入しておく必要があります。
この変数内に、実行している非同期処理が代入されているので、それを後で止めることが出来ます。

参考サイト
Qiita @Marimoiro 様
UniRxのシンプルなサンプルその6(購読の停止)

ObservableEventTrigger における実装例

事前準備

　Canvas 内に Image ゲームオブジェクトを配置、あるいは、Sceneビュー内に Cube ゲームオブジェクトなどを配置し、
それに ObservableEventTrigger コンポーネントをアタッチしてください。

　どちらを利用しても構いません。

　最初に Canvas の方の例を提示しておきます。

ヒエラルキー画像

Image ゲームオブジェクト　インスペクター画像

Game ビュー

　もう１つ例として、Sceneビュー内にゲームオブジェクトを配置し、こちらを利用するケースです。
注意点としては、ヒエラルキーに EventSystem が必要なことと、MainCamera ゲームオブジェクトに
Physics Raycaster コンポーネントのアタッチが必要になる点です。
　

ヒエラルキー画像

MainCamera ゲームオブジェクト　インスペクター画像

Cube ゲームオブジェクト　インスペクター画像

Game ビュー

スクリプトの実装例

　作成したゲームオブジェクトをマウスでクリックした際に反応するように
ObservableEventTrigger を利用し、OnPointerDownAsObservable() を Subscribe して購読します。

　Start メソッドで Subscribe した処理について、特定のボタンを押したタイミングで購読処理を停止します。
その後、別の処理を再度購読させるように処理をつなげます。
また、AddTo メソッドをつけているので、ゲームオブジェクトが破棄されたタイミングでも購読処理を停止できます。

EventTriggerTest.cs

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

using System;
using UnityEngine;
using UniRx;
using UniRx.Triggers;

public class EventTriggerTest : MonoBehaviour
{
    private ObservableEventTrigger eventTrigger;
    private IDisposable disposable;　   　// Subscribe する変数を代入し、Dispose 出来るようにする


    void Start()
    {
        if (TryGetComponent(out eventTrigger)) {

            // Subscribe する際に、その戻り値の値を disposable に代入しておく
            disposable = eventTrigger.OnPointerDownAsObservable()
                .Subscribe(_ => Debug.Log("A"))
                .AddTo(gameObject);
        }
    }

    void Update() {

        // ボタンを押したら、今の購読処理を停止して、新しい購読処理に変える
        if (Input.GetKeyDown(KeyCode.P)) {
            Debug.Log("Space 押下");
            SetNewEvent();
        }
    }

    /// <summary>
    /// 現在の購読処理を停止し、新しい購読処理を開始する
    /// </summary>
    private void SetNewEvent() {

        // Start メソッドで代入しておいた Subscribe の購読処理を停止する
        disposable.Dispose();        

        // 新しい購読処理を実行する。これも Subscribe の戻り値を disposable に代入しておけば、後で停止可能
        eventTrigger.OnPointerDownAsObservable()
            .Subscribe(_ => Debug.Log("B"))
            .AddTo(gameObject);
    }
}

　スクリプトを作成したらセーブします。

　Image ゲームオブジェクト、あるいは Cube ゲームオブジェクトに EventTriggerTest スクリプトをアタッチします。

Image ゲームオブジェクト　インスペクター画像

Cube ゲームオブジェクト　インスペクター画像

処理の説明

　Dispose するまでの処理の流れ、および、再度、購読の処理を始める際の処理について、処理を読み解き、理解を深めておいてください。

　また、System の IDisposable を利用せず、UniRx のみで停止したい場合には、
SingleAssignmentDisposable 型を利用することでも代用可能です。

＜System.Disposable の代用処理＞
EventTriggerTest.cs

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

using UnityEngine;
using UniRx;
using UniRx.Triggers;

public class EventTriggerTest : MonoBehaviour
{
    private ObservableEventTrigger eventTrigger;
    private SingleAssignmentDisposable disposable = new();　   　// Subscribe する変数を代入し、Dispose 出来るようにする


    void Start()
    {
        if (TryGetComponent(out eventTrigger)) {

            // Subscribe する際に、その戻り値の値を disposable.Disposable に代入しておく
            disposable.Disposable = eventTrigger.OnPointerDownAsObservable()
                .Subscribe(_ => Debug.Log("A"))
                .AddTo(gameObject);
        }
    }

    void Update() {
        // 同じなので省略
    }

    private void SetNewEvent() {

        // 同じなので省略
    }
}

　変数の宣言と処理の代入方法が変わりますが、流れは同じです。
停止命令は IDisposable インターフェースの Dispose メソッドに対して実行するため、同じ命令処理で停止出来ます。

　UniRxの場合、複数の購読の処理をまとめて停止したいときには、IDisposable インターフェースを実装している
CompositeDisposable 型を利用することで停止させることが出来ます。

参考サイト
Qiita @yaegaki 様
UniRx 購読を停止する

実装動画

　Debug.Log メソッドを利用し、処理が正常に動作しているかを確認します。

　Space ボタンを押したタイミングで、最初に購読していた処理が停止し、代わりに別の処理が購読されるようになっています。

＜確認動画①　Image ゲームオブジェクトのケース＞

動画ファイルへのリンク

＜確認動画②　Cube ゲームオブジェクトのケース＞

動画ファイルへのリンク

＜Console ビュー画像＞

　以上になります。

Subscribe による購読処理であれば、購読元になっている型は違っても、同じように停止・再行動させることが可能です。

　応用方法を考えてみてください。

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

印刷する

コメント（0）

UniRx の購読停止と再購読の実装例② - i-school 先頭へ

コメントをかく

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

i-school