methodName | Name of coroutine. |
routine | Name of the function in code, including coroutines. |
Stops the first coroutine named methodName
, or the coroutine stored in routine
running on this behaviour.
StopCoroutine takes one of three arguments which specify which coroutine is stopped:
- A string function naming the active coroutine
- The IEnumerator
variable used earlier to create the coroutine.
- The Coroutine
to stop the manually created Coroutine
.
Note: Do not mix the three arguments. If a string is used as
the argument in StartCoroutine, use the string in StopCoroutine.
Similarly, use the IEnumerator
in both StartCoroutine and StopCoroutine.
Finally, use StopCoroutine
with the Coroutine
used for creation.
In the CS example, the IEnumerator type is used.
using UnityEngine; using System.Collections;
public class Example : MonoBehaviour { // keep a copy of the executing script private IEnumerator coroutine;
// Use this for initialization void Start() { print("Starting " + Time.time); coroutine = WaitAndPrint(3.0f); StartCoroutine(coroutine); print("Done " + Time.time); }
// print to the console every 3 seconds. // yield is causing WaitAndPrint to pause every 3 seconds public IEnumerator WaitAndPrint(float waitTime) { while (true) { yield return new WaitForSeconds(waitTime); print("WaitAndPrint " + Time.time); } }
void Update() { if (Input.GetKeyDown("space")) { StopCoroutine(coroutine); print("Stopped " + Time.time); } } }
The following cs example shows how StopCoroutine(Coroutine) can be used.
using System.Collections; using System.Collections.Generic; using UnityEngine;
public class ExampleClass : MonoBehaviour { void Start() { StartCoroutine(coroutineA()); }
IEnumerator coroutineA() { // wait for 1 second yield return new WaitForSeconds(1.0f); Debug.Log("coroutineA() started: " + Time.time);
// wait for another 1 second and then create b yield return new WaitForSeconds(1.0f); Coroutine b = StartCoroutine(coroutineB());
yield return new WaitForSeconds(2.0f); Debug.Log("coroutineA() finished " + Time.time);
// B() was expected to run for 10 seconds // but was shut down here after 3.0f StopCoroutine(b); yield return null; }
IEnumerator coroutineB() { float f = 0.0f; float start = Time.time;
Debug.Log("coroutineB() started " + start);
while (f < 10.0f) { Debug.Log("coroutineB(): " + f); yield return new WaitForSeconds(1.0f); f = f + 1.0f; }
// Intended to handling exit of the this coroutine. // However coroutineA() shuts coroutineB() down. This // means the following lines are not called. float t = Time.time - start; Debug.Log("coroutineB() finished " + t); yield return null; } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.