BetterCoroutines Class

A very similar but more performant alternative to Unity's coroutines. A coroutine do not belong to any gameobject and therefore doesn't depend on their life cycle. You can however optionally link the coroutines to a gameobject or component. Which update loop they're part of can be specified when they're started. They also allocate less garbage (especially with the yield instructions). Just as with Unity's coroutines you can yield a WWW and AsyncOperation to wait for them to finish. Instead of using Unity's YieldInstructions you should use the pooled replacements:

Inheritance Hierarchy

SystemObject
Archon.SwissArmyLib.CoroutinesBetterCoroutines

Namespace: Archon.SwissArmyLib.Coroutines
Assembly: Archon.SwissArmyLib (in Archon.SwissArmyLib.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

Copy

public class BetterCoroutines : IEventListener

Request Example View Source

The BetterCoroutines type exposes the following members.

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Destructor. (Overrides ObjectFinalize.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the type of the current instance. (Inherited from Object.)
	IsPaused	Checks whether a coroutine is currently paused either directly or because of a paused parent.
	IsRunning	Checks whether a coroutine with the given ID is running. A paused coroutine is still considered running.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Pause	Pauses a coroutine.
	SetPaused	Pauses or unpauses a coroutine.
	Start(IEnumerator, UpdateLoop)	Starts a new coroutine.
	Start(IEnumerator, Int32)	Starts a new coroutine.
	Start(IEnumerator, GameObject, UpdateLoop)	Starts a new coroutine and links its lifetime to a gameobject. The coroutine will be stopped when the linked gameobject is disabled or destroyed.
	Start(IEnumerator, GameObject, Int32)	Starts a new coroutine and links its lifetime to a gameobject. The coroutine will be stopped when the linked gameobject is disabled or destroyed.
	Start(IEnumerator, MonoBehaviour, UpdateLoop)	Starts a new coroutine and links its lifetime to a component. The coroutine will be stopped when the linked component is disabled or destroyed.
	Start(IEnumerator, MonoBehaviour, Int32)	Starts a new coroutine and links its lifetime to a component. The coroutine will be stopped when the linked component is disabled or destroyed.
	Stop	Stops a running coroutine prematurely. This will stop any child coroutines as well.
	StopAll	Stops all coroutines.
	StopAll(Int32)	Stops all coroutines that are running in the specified update loop.
	StopAll(UpdateLoop)	Stops all coroutines that are running in the specified update loop.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unpause	Unpauses a paused coroutine.
	WaitForAsyncOperation	Waits until the specified AsyncOperation is done.
	WaitForSeconds	Waits for the specified amount of seconds, either in scaled time (just as Unity's WaitForSeconds) or in unscaled time.
	WaitForSecondsRealtime	Waits for the specified amount of seconds in real time. Lighter replacement for WaitForSecondsRealtime.
	WaitForWWW	Waits until the specified WWW object has finished.
	WaitUntil	Waits until the given predicate returns true.
	WaitWhile	Waits until the given predicate returns false.

Top

Fields

	Name	Description
	WaitForEndOfFrame	Suspends a coroutine until the very end of the current frame.
	WaitForOneFrame	Suspends a coroutine for one frame.

Top

Reference

Archon.SwissArmyLib.Coroutines Namespace