SeratoninRonin / CoroutineManager

Unity-style coroutines in Godot C#

CoroutineManager

Coroutines are implemented in GDScript, and the onsignals can be done in C# using async/await, but for those of us who like C#/Unity style coroutines, I present:

Unity-style coroutines in Godot C#!

The CoroutineManager lets you pass in an IEnumerator which is then ticked each frame allowing you to break long running tasks up into smaller bits. The entry point for starting a coroutine is CoroutineManager.StartCoroutine which returns an ICoroutine object with a single method: Stop. The execution of a coroutine can be paused at any point using the yield statement.

Coroutines can yield a few different ways:

• yield return null (tick again the next frame)
• yield return Coroutine.WaitForSeconds( 3 ) (tick again after a 3 second delay)
• yield return CoroutineManager.StartCoroutine( another() ) (wait for the other coroutine before getting ticked again)

Usage

The /addons/CoroutineManager folder should be copied into your own project's /addons folder

The CoroutineManager.tscn file should be added to your Project Settings -> AutoLoad as a global, like so:

Example

using System.Collections;

public IEnumerator MyCoroutine()
{
    if(waitCondition)
    {
      yield return Coroutine.WaitForSeconds(1);
    }
    
    for(int i=0;i<10000;i++)
    {
      if(search[i]==result)
        yield return CoroutineManager.StartCoroutine(ProcessResult());
      else
        yield return null;
    }
}

public override void __Ready()
{
    var coroutine = CoroutineManager.StartCoroutine(MyCoroutine());
    if(stopCondition)
    {
      coroutine.Stop();
    }
}

Acknowledgements/Attribution

This was adapted from the excellent Nez framework for MonoGame: https://github.com/prime31/Nez

License

This project is MIT licensed and provided as-is.