MonoBehaviour.StopCoroutine

function StopCoroutine (methodName : String) : void

Description

Stops all coroutines named methodName running on this behaviour.

Please note that only StartCoroutine using a string method name can be stopped using StopCoroutine.

JavaScripts

// In this example we show how to invoke a coroutine using a string name and stop it

function Start () {
StartCoroutine("DoSomething", 2.0);
yield WaitForSeconds(1);
StopCoroutine("DoSomething");
}

function DoSomething (someParameter : float) {
while (true) {
print("DoSomething Loop");
// Yield execution of this coroutine and return to the main loop until next frame
yield;
}
}

using UnityEngine;
using System.Collections;

public class example : MonoBehaviour {
IEnumerator Start() {
StartCoroutine("DoSomething", 2.0F);
yield return new WaitForSeconds(1);
StopCoroutine("DoSomething");
}
IEnumerator DoSomething(float someParameter) {
while (true) {
print("DoSomething Loop");
yield return null;
}
}
}

import UnityEngine
import System.Collections

class example(MonoBehaviour):

def Start() as IEnumerator:
StartCoroutine('DoSomething', 2.0F)
yield WaitForSeconds(1)
StopCoroutine('DoSomething')

def DoSomething(someParameter as single) as IEnumerator:
while true:
print('DoSomething Loop')
yield