Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Suggest a change
StopCoroutine(methodName: string): void;
void StopCoroutine(string methodName);
def StopCoroutine(methodName as string) as void
StopCoroutine(routine: IEnumerator): void;
void StopCoroutine(IEnumerator routine);
def StopCoroutine(routine as IEnumerator) as 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.

	// 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 ExampleClass : 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

public class ExampleClass(MonoBehaviour):

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

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

Your name (optional):
Your email (optional):
Please write your suggestion here: