UniRxで実装したタイマーを一時停止／再開したい

Question

ゲームのポーズ機能のため、UniRxで実装したタイマーを一時停止／再開させたいのですが、知識不足でキレイな方法が浮かびません。

実装コード（Observable）

public class TimerManager : MonoBehaviour
{
    // 試合開始前のカウントダウン（Observable）
    public IObservable<int> GameStartCountDownObservable => gameStartCountDownObservable.AsObservable();
    private IConnectableObservable<int> gameStartCountDownObservable;

    // 試合中のカウントダウン（Observable）
    public IObservable<int> InPlayCountDownObservable => inPlayCountDownObservable.AsObservable();
    private IConnectableObservable<int> inPlayCountDownObservable;

    // カウントダウン秒数
    public int CountDownTime { get; private set; } = 2;

    // プレイ秒数
    public int PlayTime { get; private set; } = 60;

    void Awake()
    {
        // 試合前のカウントダウンタイマ
        // CountDownTime秒タイマのストリームをPublishでHot変換（まだConnectはしない）
        gameStartCountDownObservable = CreateCountDownObservable(CountDownTime).Publish();

        // 試合中のタイマ
        // PlayTime秒タイマのストリームをPublishでHot変換（まだConnectはしない）
        inPlayCountDownObservable = CreateCountDownObservable(PlayTime).Publish();

        // 3秒タイマのOnCompleteで60秒タイマをConnectする（60秒タイマの起動）
        // おそらく第二引数がコンプリート時のコールバック処理
        gameStartCountDownObservable.Subscribe(_ => {; }, () => inPlayCountDownObservable.Connect());
    }

    // CountTimeだけカウントダウンするストリーム
    private IObservable<int> CreateCountDownObservable(int countTime)
    {
        return Observable
            .Timer(TimeSpan.FromSeconds(0), TimeSpan.FromSeconds(1))
            .Select(x => (int)(countTime - x))
            .TakeWhile(x => x > 0);
    }

    // カウントダウンを開始
    public void StartCountDown()
    {
        // ゲーム開始前のカウントダウンのタイマ起動
        gameStartCountDownObservable.Connect();
    }
}

購読側

あとは外部スクリプトでTimeManager.StartCountDown()を実行してConnect。
以下のように購読してカウントダウンの秒数を取得しています。

// Connect
TimeManager.StartCountDown();

// カウントダウンの購読
TimerManager.GameStartCountDownObservable
    .Subscribe(time =>
    {
        Debug.Log(time);
    }, () =>
    {
        // カウントダウンが完了したとき
        // ゲーム開始
        GameManager.StartGame();
    })
    .AddTo(this);

---

この状態で

• ポーズボタンを押したらカウントダウンを停止
• 再開ボタンを押したらカウントダウンを再開

したいのですが、上手いやり方が中々思いつきません。

経過秒数を小数点含めて保持しポーズ時にDisposeで破棄、再開時に経過秒数で初期化しConnectする他ないのでしょうか。
ご教授いただけますと幸いです。

Answer 1

「経過秒数を小数点含めて保持しポーズ時にDisposeで破棄、再開時に経過秒数で初期化しConnect」とおっしゃる方針でも行けるかもしれませんが、ちょっと複雑になってしまいそうな気配がしますね...
Timerの代わりにコルーチンで時間を計るというのはどうでしょうかね?

試しにCreateCountDownObservableが作るストリームをコルーチンベースに変更してみました。

using System;
using System.Collections;
using UniRx;
using UnityEngine;

public class TimerManager : MonoBehaviour
{
    private IConnectableObservable<int> gameStartCountDownObservable;

    private IConnectableObservable<int> inPlayCountDownObservable;

    // 試合開始前のカウントダウン（Observable）
    public IObservable<int> GameStartCountDownObservable => gameStartCountDownObservable.AsObservable();

    // 試合中のカウントダウン（Observable）
    public IObservable<int> InPlayCountDownObservable => inPlayCountDownObservable.AsObservable();

    // カウントダウン秒数
    public int CountDownTime { get; } = 2;

    // プレイ秒数
    public int PlayTime { get; } = 60;

    private void Awake()
    {
        // 試合前のカウントダウンタイマ
        // CountDownTime秒タイマのストリームをPublishでHot変換（まだConnectはしない）
        gameStartCountDownObservable = CreateCountDownObservable(CountDownTime).Publish();

        // 試合中のタイマ
        // PlayTime秒タイマのストリームをPublishでHot変換（まだConnectはしない）
        inPlayCountDownObservable = CreateCountDownObservable(PlayTime).Publish();

        // 3秒タイマのOnCompleteで60秒タイマをConnectする（60秒タイマの起動）
        // おそらく第二引数がコンプリート時のコールバック処理
        gameStartCountDownObservable.Subscribe(_ => { ; }, () => inPlayCountDownObservable.Connect());
    }

    // CountTimeだけカウントダウンするストリーム
    private IObservable<int> CreateCountDownObservable(int countTime)
    {
        return Observable.FromCoroutine<int>(observer => CountDownCoroutine(observer, countTime));
    }

    private float timeScale = 1.0f;

    // 時間経過速度の倍率
    public float TimeScale
    {
        get => timeScale;
        set => timeScale = Mathf.Max(value, 0.0f);
    }

    private IEnumerator CountDownCoroutine(IObserver<int> observer, int countTime, float interval = 1.0f)
    {
        var phase = interval;
        while (true)
        {
            yield return null;

            // 経過時間を積算していく
            // このとき、経過時間にタイムスケールを乗じることで
            // 時間経過の速さをコントロールする
            phase += Time.deltaTime * timeScale;

            // phaseがintervalを超えるたびに値を発行する
            if (phase >= interval)
            {
                var invocationCount = (int)(phase / interval);
                phase %= interval;
                for (var i = 0; i < invocationCount; i++)
                {
                    if (countTime > 0)
                    {
                        observer.OnNext(countTime);
                    }
                    else
                    {
                        observer.OnCompleted();
                        yield break;
                    }

                    countTime--;
                }
            }
        }
    }

    // カウントダウンを開始
    public void StartCountDown()
    {
        // ゲーム開始前のカウントダウンのタイマ起動
        gameStartCountDownObservable.Connect();
    }
}

上記のように改変したTimerManagerを、別途実験用に用意した下記スクリプトから利用したところ...

using System.Collections;
using System.Diagnostics;
using UniRx;
using UnityEngine;
using Debug = UnityEngine.Debug;

public class TimerTest : MonoBehaviour
{
    [SerializeField] private TimerManager timerManager;

    private bool isCounting = true;

    private IEnumerator Start()
    {
        // スペースキーを押して実験開始
        Debug.Log("Hit space to start countdown.");
        var waitUntilSpace = new WaitUntil(() => Input.GetKeyDown(KeyCode.Space));
        yield return waitUntilSpace;

        // 参考情報として経過時間を測定する
        var stopwatch = new Stopwatch();
        stopwatch.Start();

        // Connect
        timerManager.StartCountDown();

        // カウントダウンの購読
        timerManager.GameStartCountDownObservable
            .Subscribe(
                time =>
                {
                    Debug.Log($"GameStartCountDown: {time}, Elapsed: {stopwatch.ElapsedMilliseconds * 0.001:F3}");
                },
                () =>
                {
                    // カウントダウンが完了したとき
                    // ゲーム開始
                    Debug.Log($"Start game! Elapsed: {stopwatch.ElapsedMilliseconds * 0.001:F3}");
                })
            .AddTo(this);
        timerManager.InPlayCountDownObservable
            .Subscribe(
                time => { Debug.Log($"InPlayCountDown: {time}, Elapsed: {stopwatch.ElapsedMilliseconds * 0.001:F3}"); },
                () =>
                {
                    // カウントダウンが完了したとき
                    // ゲーム終了
                    Debug.Log($"Time is up! Elapsed: {stopwatch.ElapsedMilliseconds * 0.001:F3}");
                    stopwatch.Stop();
                })
            .AddTo(this);

        // スペースキーを押したらタイムスケールを1.0または0.0に切り替えることで
        // カウントを一時停止、または再開する
        // なお、停止中は参考用のストップウォッチも一時停止することにした
        while (true)
        {
            yield return null;
            yield return waitUntilSpace;

            isCounting = !isCounting;
            if (isCounting)
            {
                timerManager.TimeScale = 1.0f;
                stopwatch.Start();
                Debug.Log($"Resumed. Elapsed: {stopwatch.ElapsedMilliseconds * 0.001:F3}");
            }
            else
            {
                timerManager.TimeScale = 0.0f;
                stopwatch.Stop();
                Debug.Log($"Paused. Elapsed: {stopwatch.ElapsedMilliseconds * 0.001:F3}");
            }
        }
    }
}

下図のような挙動になりました。

Comments

[hartan]

あまりにもご丁寧な回答をいただきビックリしております…！
コードの理解と既存コードへの組み込み＆動作確認に時間がかかり、返信まで遅くなってしまいました。

問題なく停止／再開させることができました！
`TimeScale`を1か0に切り替えるだけのシンプルな変更ですね…恐れ入ります。

`Stopwatch`クラスや`WaitUntil`の使い方なども勉強させていただきました。
この度は本当にありがとうございました。
今回の内容を糧に精進いたしますm(__)m