Click or drag to resize

BetterCoroutinesExtensionsStopBetterCoroutine Method

Stops a running coroutine prematurely. This will stop any child coroutines as well.

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 bool StopBetterCoroutine(
	this Object unityObject,
	int coroutineId
)
Request Example View Source

Parameters

unityObject
Type: Object

[Missing <param name="unityObject"/> documentation for "M:Archon.SwissArmyLib.Coroutines.BetterCoroutinesExtensions.StopBetterCoroutine(UnityEngine.Object,System.Int32)"]

coroutineId
Type: SystemInt32
The id of the coroutine to stop.

Return Value

Type: Boolean
True if the coroutine was found and stopped, otherwise false.

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