【Unity】UniRx のオペレーターと各メソッドの使用方法

UniRx のオペレーターと各メソッドの使用方法

スクリプト

using UniRx;
using UniRx.Triggers;
using UnityEngine;

public class Sample : MonoBehaviour
{
    [SerializeField]
    private GameObject objSample;

    [SerializeField]
    private Button btnSample;

    private void Start()
    {
        //Sample オブジェクトの「OnCollisionEnter()」を「Observable」に変換して購読する（監視開始）
        objSample.OnCollisionEnterAsObservable()
            //他のコライダーに接触したら Obsevable からメッセージが発行され、それを受け取って collision 変数を渡し、接触相手の名前を表示する
            .Subscribe(collision => Debug.Log(collision.gameObject.name))
            //Sample クラスが消えたら講読をやめる
            .AddTo(this);

        //Sample クラスの「OnDestroy()」を「Observable」に変換して購読する（監視開始）
        this.OnDestroyAsObservable()
            //Sample クラスが消えたら Obsevable からメッセージが発行され、それを受け取って「破棄された」と表示する
            .Subscribe(_ => Debug.Log("破棄された"));
        //Sample ボタンの UnityEvent である onClick を Observable に変換して購読する（監視開始）
        btnSample.OnClickAsObservable()
            //Sample ボタンが押されたら Observable からメッセージが発行されるが、2.0秒間、2回目以降のメッセージを無視する
            .ThrottleFirst(System.TimeSpan.FromSeconds(2.0f))
            //Observable から発行されたメッセージを受け取って「押された」と表示する
            .Subscribe(_ => Debug.Log("押された"))
            //Sample クラスが消えたら講読をやめる
            .AddTo(this);

        //Sample クラスの「Update()」を「Observable」に変換して購読する（監視開始）
        this.UpdateAsObservable()
            //Observable からメッセージが毎フレーム発行されるが、スペースキーが押されていない間はそれらのメッセージを無視する
            .Where(_ => Input.GetKey(KeyCode.Space))
            //2.0秒間、2回目以降のメッセージを無視する
            .ThrottleFirst(System.TimeSpan.FromSeconds(2.0f))
            //Observable から発行されたメッセージを受け取って「ジャンプ」と表示する
            .Subscribe(_ => Debug.Log("ジャンプ"))
            //Sample クラスが消えたら講読をやめる
            .AddTo(this);
    }
}

各メソッド

オペレーター

その他

処理の流れ

説明

上記の例では、Sample オブジェクトや Sample ボタンが対象先で「~AsObservable()」が「Obsevable」であり、「１つのメッセージの塊」である。

これが「Subscribe()」に登録できる Observer オブジェクトである。

このようにする事で購読（監視）を開始させるが、これだけではメッセージ（通知）を発行しても受け取り先が無いため、「Subscribe()」を使用する事で発行したメッセージ（通知）を受け取って、処理が連動して動くようになっている。

これらの処理の間に入るのが「Where()」や「ThrottleFirst()」等のオペレーターであり、メッセージの情報をフィルタリングしている。

「Observableを購読する」とは「ObservableのSubscribe()」を実行して、Observer オブジェクトを登録するという意味である。

流れ

1. objSample（Subject オブジェクト）
2. ~AsObservable()（Observer オブジェクト）
3. Where()（オペレーター）
4. Subscribe()（Observer に処理を繋いでメソッド内の処理を実行する）

※オペレーターは無くても良い

お問い合わせ