Stopping coroutines in Unity - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a coroutine in Unity?

A coroutine is a special function that can pause execution and resume later, allowing you to run code over multiple frames without blocking the main game loop.

beginner

How do you start a coroutine in Unity?

You start a coroutine by calling StartCoroutine(MethodName()) inside a MonoBehaviour script.

intermediate

What method is used to stop a running coroutine by its name?

You can stop a coroutine by calling StopCoroutine("MethodName"), passing the coroutine's method name as a string.

intermediate

How can you stop a coroutine using a Coroutine variable?

When you start a coroutine, you can save its reference like Coroutine myCoroutine = StartCoroutine(MethodName()). Then stop it by calling StopCoroutine(myCoroutine).

intermediate

What happens if you call StopAllCoroutines() in a MonoBehaviour?

It stops all coroutines running on that MonoBehaviour immediately, cancelling all paused or running coroutine executions.

Which method stops all coroutines running on a MonoBehaviour?

A StopAllCoroutines()

B StopCoroutine()

C EndCoroutine()

D CancelCoroutine()

StopAllCoroutines() stops every coroutine running on the MonoBehaviour. The others are incorrect or do not exist.

How do you stop a coroutine if you only know its method name?

A StopCoroutine(coroutineVariable)

B StopCoroutine(MethodName())

C StopCoroutine("MethodName")

D StopAllCoroutines()

Use the method name as a string in StopCoroutine to stop it by name.

What must you save when starting a coroutine to stop it later by reference?

A Coroutine variable from StartCoroutine()

B Method name string

C IEnumerator variable

D GameObject reference

Saving the Coroutine returned by StartCoroutine() lets you stop it later by passing that variable.

What happens if you call StopCoroutine on a coroutine that is not running?

A Throws an exception

B Nothing happens, no error

C Restarts the coroutine

D Pauses the coroutine

Calling StopCoroutine on a non-running coroutine does nothing and does not cause errors.

Which of these is NOT a valid way to stop a coroutine?

A StopCoroutine(coroutineVariable)

B StopCoroutine("MethodName")

C StopCoroutine(IEnumerator variable)

D StopCoroutine(GameObject)

You cannot stop a coroutine by passing a GameObject. The others are valid ways.

Explain how to stop a coroutine in Unity using both the method name and Coroutine variable approaches.

Think about the two common ways Unity lets you stop coroutines.

Describe what StopAllCoroutines does and when you might want to use it.

Consider a situation where many coroutines run and you want to stop them all quickly.

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