PausableObject - Any interest in a tool that can pause coroutines?

I'm not a big fan of the Time.timescale = 0 method of pausing your game. I'd rather pause Components individually, to control exactly what's going on.

Tonight I'm wrapping up a tool for my own toolbox: PausableObject. Deriving scripts from PausableObject makes it easy to pause and unpause their activity.

You get access to a Paused property (for pausing activity in Update loops), as well as OnPaused() and OnUnpaused() callbacks.

Code (CSharp):

1. public class TestPausableObject : PausableObject
2. {
3.     void Update()
4.     {
5.         // just a quick example to show how pausing/unpausing works
6.         if(Input.GetKeyDown(KeyCode.Space))
7.         {
8.             Paused = !Paused;
9.         }
10.  
11.         if(!Paused)
12.         {
13.             // do awesome Update stuff
14.         }
15.     }
16.  
17.     protected override void OnPaused ()
18.     {
19.        // pause something external, like an animation
20.     }
21.  
22.     protected override void OnUnpaused ()
23.     {
24.         // unpause something external, like an animation
25.     }
26. }

Ok sure, but more useful, you get access to a StartPausableCoroutine() method. This will start normal unity Coroutines, but will automatically pause their execution when Paused == true (and resume them when Paused == false).

This coroutine will pause just fine:

Code (CSharp):

1. public class TestPausableObject : PausableObject
2. {
3.     void Awake()
4.     {
5.         StartPausableCoroutine(RunPauseTest(10));
6.  
7.         // or
8.  
9.         StartPausableCoroutine("RunPauseTest", 10);
10.     }
11.  
12.     IEnumerator RunPauseTest(float seconds)
13.     {
14.         Debug.Log(Time.timeSinceLevelLoad);
15.  
16.         yield return null;
17.  
18.         Debug.Log(Time.timeSinceLevelLoad);
19.  
20.         yield return new WaitForSeconds(seconds);
21.  
22.         Debug.Log(Time.timeSinceLevelLoad);
23.  
24.         yield return new WaitForEndOfFrame();
25.  
26.         Debug.Log(Time.timeSinceLevelLoad);
27.  
28.         yield return new WaitForFixedUpdate();
29.  
30.         Debug.Log(Time.timeSinceLevelLoad);
31.  
32.         yield return StartPausableCoroutine(WaitForTime(0.1f));
33.  
34.         // (also works with yielding WWW objects)
35.     }
36.  
37.     IEnumerator WaitForTime(float time)
38.     {
39.         yield return new WaitForSeconds(time);
40.     }
41. }

I'm wondering if people have written scripts like this into their own project, and if there'd be any general interest for having something like this on the AS.

Cheers!
-Orion

 

I haven't searched for anything similar and I didn't have the need yet, but if I do have the need at some point, this seems like a solution I would use for pausing.

 

A question for anyone: How do you currently handle pausing in your projects? Timescale = 0, or have you rolled your own method?

Thanks!
Orion