| BetterCoroutinesStart Method (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.
Namespace:
Archon.SwissArmyLib.Coroutines
Assembly:
Archon.SwissArmyLib (in Archon.SwissArmyLib.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax public static int Start(
IEnumerator enumerator,
GameObject linkedObject,
UpdateLoop updateLoop = UpdateLoop.Update
)
Request Example
View SourceParameters
- enumerator
- Type: System.CollectionsIEnumerator
- linkedObject
- Type: GameObject
Which gameobject to link the coroutine's lifetime with. - updateLoop (Optional)
- Type: Archon.SwissArmyLib.UtilsUpdateLoop
Which update loop should the coroutine be part of?
Return Value
Type:
Int32The id of the coroutine.
See Also