Click or drag to resize

BetterCoroutinesExtensionsStartBetterCoroutine Method (Object, IEnumerator, UpdateLoop)

Starts a new coroutine.

Namespace:  Archon.SwissArmyLib.Coroutines
Assembly:  Archon.SwissArmyLib (in Archon.SwissArmyLib.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
Copy
public static int StartBetterCoroutine(
	this Object unityObject,
	IEnumerator enumerator,
	UpdateLoop updateLoop = UpdateLoop.Update
)
Request Example View Source

Parameters

unityObject
Type: Object

[Missing <param name="unityObject"/> documentation for "M:Archon.SwissArmyLib.Coroutines.BetterCoroutinesExtensions.StartBetterCoroutine(UnityEngine.Object,System.Collections.IEnumerator,Archon.SwissArmyLib.Utils.UpdateLoop)"]

enumerator
Type: System.CollectionsIEnumerator

[Missing <param name="enumerator"/> documentation for "M:Archon.SwissArmyLib.Coroutines.BetterCoroutinesExtensions.StartBetterCoroutine(UnityEngine.Object,System.Collections.IEnumerator,Archon.SwissArmyLib.Utils.UpdateLoop)"]

updateLoop (Optional)
Type: Archon.SwissArmyLib.UtilsUpdateLoop
Which update loop should the coroutine be part of?

Return Value

Type: Int32
The id of the coroutine.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Object. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
See Also