コルーチンの使い方 (Coroutines) [Unity]

コルーチン

公式サイト：

コルーチン | Unity マニュアル [公式]

概要

参考：

古来より Unity 非同期を実現していたコルーチンとは何者か？ – Qiita

使い方

参考：

Unity におけるコルーチンの性質まとめ – Qiita

非同期処理を理解するコルーチン編 – Qiita

コルーチンの使い方 | TECH PROjin

Unity におけるコルーチンの使い方 | creive

コルーチン | yttm-work

導入

参考：

Unity のコルーチン機能を使ってみる | MR が楽しい

IEnumerator を使って非同期処理を行う | わたぶろぐ

yield

yield return null：次のフレームまで処理を中断する
yield break：コルーチンの実行を終了する

参考：

コルーチンで処理を中断／再開／停止させる方法を学ぶ | XR-Hub

コルーチンの中断処理 | まみももめも

コルーチンの中断／終了の仕方いろいろ – Qiita

Unity のコルーチン待機での yield retun 0 と yield retun null の違い | netsis

yield return 0 を使用すると 20B の GC Alloc が発生する | コガネブログ

How do I return a value from a coroutine? – Unity Answers

IEnumerator’s yield return null – Stack Overflow

What is the difference between “yield return 0” and “yield return null” in Coroutine? – Stack Overflow

WaitForSeconds

コルーチン内で処理を5秒間中断する。

yield return new WaitForSeconds(5.0f);
Code language: C# (cs)

※ new により 20 バイトのメモリ割り当てが発生するので、高頻度で使用する場合は、ループ外でキャッシュしておいて再利用する方が良い。

var wait = new WaitForSeconds(0.01f);
while (true) {
    yield return wait;
}
Code language: C# (cs)

参考：

コルーチンで処理を中断／再開／停止させる方法を学ぶ | XR-Hub

クリックしてから1秒間だけ true にする | フタバゼミ

Unity の GC Allocate と WaitForSeconds – Qiita

WaitForSeconds はキャッシュして使おう | 渋谷ほととぎす通信

UnityEngine.WaitForSeconds | Unity スクリプトリファレンス [公式]

I want to understand the syntax of coroutines – Stack Overflow

WaitForEndOfFrame

次のフレームをレンダリングした後に処理を再開する。

参考：

yield return null と WaitForEndOfFrame の違い | ロバメモ

WaitForEndOfFrame でフレームを送ると Input が拾えない – Qiita

コルーチン内から他のコルーチンを呼び出す

yield return に StartCoroutine を呼び出して与える。

yield return StartCoroutine("AnotherCoroutine");
Code language: C# (cs)

参考：

コルーチンで処理を中断／再開／停止させる方法を学ぶ | XR-Hub

キー入力を待つ

参考：

コルーチン内で入力待ちする | トーフメモ

How to make unity wait until i press i key – Stack Overflow

キーを押している間のみ処理を実行する

参考：

Start a Coroutine on Key Press (and keep it running) – Unity Answers

値を返したい

参考：

Unity のコルーチンで値を返す方法／いくつか方法あるぽいけど、その一つを紹介 | ハルシオンシステムの気ままBlog

Update からコルーチンを開始する

処理が実行中の場合にコルーチンが二重に生成されないよう、ガードを追加する。

private bool isRunning = false;

IEnumerator DoSomething()
{
    if (isRunning) {
        yield break;
    }
    isRunning = true;

    while (/* condition */)
    {
        // Do something
        yield return null;
    }

    // End of running
    isRunning = false;
}
Code language: C# (cs)