Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

StopAllCoroutines()

Stops all coroutines running on this MonoBehaviour.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public void StopAllCoroutines()

Remarks

A MonoBehaviour can execute multiple coroutines. Created coroutines can execute for a range of times. In the following example, two coroutines are created and run without stopping until 
StopAllCoroutines
is used to stop both of them. This action can be made to happen on a script that runs multiple coroutines. No arguments are needed because all coroutines on a script are stopped.
StopAllCoroutines
operates only on the script it is attached to.

Examples

using UnityEngine;using System.Collections;// Create two coroutines that run at different speeds.// When the space key is pressed stop both of them.public class ExampleClass : MonoBehaviour{    //coroutine 1    IEnumerator DoSomething1()    {        while (true)        {            print("DoSomething1");            yield return new WaitForSeconds(1.0f);        }    }    //coroutine 2    IEnumerator DoSomething2()    {        while (true)        {            print("DoSomething2");            yield return new WaitForSeconds(1.5f);        }    }    void Start()    {        StartCoroutine("DoSomething1");        StartCoroutine("DoSomething2");    }    void Update()    {        if (Input.GetKeyDown("space"))        {            StopAllCoroutines();            print("Stopped all Coroutines: " + Time.time);        }    }}