Stopping coroutines in Unity - Mini Project: Build & Apply

Stopping coroutines

📖 Scenario: You are making a simple Unity game where an object moves up and down repeatedly using a coroutine. You want to learn how to stop this movement when the player presses a key.

🎯 Goal: Build a Unity script that starts a coroutine to move an object up and down, then stops the coroutine when the player presses the spacebar.

📋 What You'll Learn

Create a coroutine that moves an object up and down repeatedly.

Store the coroutine in a variable to control it.

Stop the coroutine when the spacebar is pressed.

Print a message when the coroutine stops.

💡 Why This Matters

🌍 Real World

Coroutines are used in games to run tasks over time without freezing the game, like animations or timed events. Knowing how to stop them lets you control game behavior smoothly.

💼 Career

Game developers often use coroutines in Unity to manage animations, delays, and sequences. Being able to start and stop coroutines is essential for responsive and efficient game code.

1

Create the MoveUpDown coroutine

Create a coroutine method called MoveUpDown that moves the object up by 1 unit, waits for 1 second, moves it down by 1 unit, and waits for 1 second in a loop.

Unity

using UnityEngine;

public class MoveObject : MonoBehaviour
{
    void Start()
    {
        // Your code here
    }

    // Create the MoveUpDown coroutine here
    // Your code here
}

Hint

Use IEnumerator to create the coroutine method. Use a while (true) loop to repeat the movement.

2

Start the coroutine and save it

In the Start method, start the MoveUpDown coroutine and save it in a variable called moveCoroutine of type Coroutine.

Unity

using UnityEngine;
using System.Collections;

public class MoveObject : MonoBehaviour
{
    Coroutine moveCoroutine;

    void Start()
    {
        // Start the MoveUpDown coroutine and save it in moveCoroutine
        // Your code here
    }

    IEnumerator MoveUpDown()
    {
        while (true)
        {
            transform.position += Vector3.up;
            yield return new WaitForSeconds(1f);
            transform.position += Vector3.down;
            yield return new WaitForSeconds(1f);
        }
    }
}

Hint

Use StartCoroutine and assign it to moveCoroutine to keep a reference.

3

Stop the coroutine on spacebar press

Add an Update method that checks if the spacebar is pressed using Input.GetKeyDown(KeyCode.Space). If pressed, stop the moveCoroutine using StopCoroutine(moveCoroutine) and print "Coroutine stopped".

Unity

using UnityEngine;
using System.Collections;

public class MoveObject : MonoBehaviour
{
    Coroutine moveCoroutine;

    void Start()
    {
        moveCoroutine = StartCoroutine(MoveUpDown());
    }

    void Update()
    {
        // Stop the coroutine when spacebar is pressed
        // Your code here
    }

    IEnumerator MoveUpDown()
    {
        while (true)
        {
            transform.position += Vector3.up;
            yield return new WaitForSeconds(1f);
            transform.position += Vector3.down;
            yield return new WaitForSeconds(1f);
        }
    }
}

Hint

Use Input.GetKeyDown(KeyCode.Space) to detect the spacebar press and StopCoroutine to stop the running coroutine.

4

Print confirmation when coroutine stops

Make sure the program prints "Coroutine stopped" to the console when the coroutine is stopped by pressing the spacebar.

Unity

using UnityEngine;
using System.Collections;

public class MoveObject : MonoBehaviour
{
    Coroutine moveCoroutine;

    void Start()
    {
        moveCoroutine = StartCoroutine(MoveUpDown());
    }

    void Update()
    {
        if (Input.GetKeyDown(KeyCode.Space))
        {
            StopCoroutine(moveCoroutine);
            Debug.Log("Coroutine stopped");
        }
    }

    IEnumerator MoveUpDown()
    {
        while (true)
        {
            transform.position += Vector3.up;
            yield return new WaitForSeconds(1f);
            transform.position += Vector3.down;
            yield return new WaitForSeconds(1f);
        }
    }

    // No additional code needed here
}

Hint

Press the spacebar while the game is running to see the message in the console.

Practice

1. What is the main purpose of stopping a coroutine in Unity?

easy

A. To halt an ongoing task or process before it finishes

B. To start a new coroutine automatically

C. To save the game state permanently

D. To increase the frame rate of the game

Solution

1. Step 1: Understand what coroutines do

   Coroutines run tasks over time, like waiting or animations.

2. Step 2: Purpose of stopping coroutines

   Stopping a coroutine means halting that ongoing task before it naturally ends.

3. Final Answer:

   To halt an ongoing task or process before it finishes -> Option A

4. Quick Check:

   Stopping coroutine = halting task [OK]

Hint: Stopping coroutines means stopping tasks in progress [OK]

Common Mistakes:

• Confusing stopping with starting coroutines
• Thinking stopping saves game data
• Assuming stopping affects frame rate

2. Which of the following is the correct syntax to stop a coroutine by its reference in Unity C#?

easy

A. EndCoroutine(coroutineReference);

B. StopCoroutineStart(coroutineReference);

C. Stop(coroutineReference);

D. StopCoroutine(coroutineReference);

Solution

1. Step 1: Recall Unity's coroutine stopping method

   Unity uses StopCoroutine() to stop coroutines by reference or name.

2. Step 2: Check method names

   Only StopCoroutine() matches Unity's API; others are invalid.

3. Final Answer:

   StopCoroutine(coroutineReference); -> Option D

4. Quick Check:

   Correct method name = StopCoroutine [OK]

Hint: Use StopCoroutine() exactly to stop by reference [OK]

Common Mistakes:

• Using incorrect method names like Stop() or EndCoroutine()
• Adding extra words like Start in method name
• Confusing with StartCoroutine syntax

3. What will be the output of the following Unity C# code snippet?

IEnumerator ExampleCoroutine() {
    Debug.Log("Start");
    yield return new WaitForSeconds(2);
    Debug.Log("End");
}

void Start() {
    Coroutine c = StartCoroutine(ExampleCoroutine());
    StopCoroutine(c);
    Debug.Log("Stopped");
}

medium

A. Start\nEnd\nStopped

B. Stopped

C. Start\nStopped

D. Start\nStopped\nEnd

Solution

1. Step 1: Analyze coroutine execution

   Coroutine logs "Start", waits 2 seconds, then logs "End".

2. Step 2: Effect of StopCoroutine

   StopCoroutine(c) stops it immediately after "Start" before "End" logs.

3. Final Answer:

   Start\nStopped -> Option C

4. Quick Check:

   StopCoroutine stops before "End" logs [OK]

Hint: StopCoroutine halts before delayed logs run [OK]

Common Mistakes:

• Assuming 'End' logs after stopping
• Ignoring immediate stop effect
• Thinking 'Stopped' logs inside coroutine

4. Identify the error in this Unity C# code snippet that tries to stop a coroutine:

IEnumerator MyCoroutine() {
    yield return new WaitForSeconds(1);
    Debug.Log("Done");
}

void Start() {
    StartCoroutine(MyCoroutine());
    StopCoroutine("MyCoroutine");
}

medium

A. StopCoroutine("MyCoroutine") requires the coroutine to be started by string name

B. StopCoroutine only works with IEnumerator variables

C. Coroutine must be stopped inside the coroutine itself

D. StopCoroutine cannot stop coroutines started without storing reference

Solution

1. Step 1: Understand how StopCoroutine(string) works

   StopCoroutine with string stops coroutines started by string name.

2. Step 2: Check how coroutine is started

   Coroutine started by method call, not by string name, so StopCoroutine("MyCoroutine") fails.

3. Final Answer:

   StopCoroutine("MyCoroutine") requires the coroutine to be started by string name -> Option A

4. Quick Check:

   StopCoroutine(string) needs string start [OK]

Hint: StopCoroutine(string) only stops coroutines started by string [OK]

Common Mistakes:

• Stopping coroutine by string without starting by string
• Thinking StopCoroutine must be inside coroutine
• Assuming StopCoroutine works with IEnumerator variables

5. You have multiple coroutines running in a Unity script. Which method stops all coroutines at once, and what is a common use case for this?

hard

A. StopCoroutineAll(); used to pause the game

B. StopAllCoroutines(); used to reset game state quickly

C. StopAll(); used to save memory

D. StopCoroutine(); used to stop one coroutine

Solution

1. Step 1: Identify method to stop all coroutines

   Unity provides StopAllCoroutines() to stop every coroutine running on that script.

2. Step 2: Understand common use case

   Stopping all coroutines helps reset game state or stop ongoing processes quickly.

3. Final Answer:

   StopAllCoroutines(); used to reset game state quickly -> Option B

4. Quick Check:

   StopAllCoroutines = stop all tasks fast [OK]

Hint: Use StopAllCoroutines() to stop every coroutine fast [OK]

Common Mistakes:

• Using wrong method names like StopAll() or StopCoroutineAll()
• Confusing stopping all with stopping one coroutine
• Misunderstanding use cases for stopping all coroutines