コルーチンの無限呼び出し

Question

前提・実現したいこと

呼び出したコルーチンが終了したら、再びそのコルーチンが開始されるように無限ループさせるには、どのように実装すればよいでしょうか。
1つのコルーチンをコルーチン内で無限にループさせるのではなく、1つのコルーチンの処理を一連の処理として、
そのコルーチンの呼び出しを無限にループさせる方法(一連の処理を無限に繰り返す方法)について考えています。
また、可能であれば、試したことで試みているように、
ループし続ける(呼び出され続ける)コルーチンと、ループさせ続ける(呼び出しを実行し続ける)コルーチンを別に分け、
ループし続けるコルーチンのほうは、引数で汎用的にセットできるようにしたいと思っています。
さらに、コルーチンの一時停止や、コルーチンの終了方法や再開についても考えています。
ご教示お願いします

試したこと

・質問1。

    void Start (){        
        StartCoroutine(LoopCoroutine(MyCoroutine(3f)));
    }

    IEnumerator LoopCoroutine(IEnumerator coroutine){
        while(true){
            yield return coroutine;
            Debug.Log("while");
        }
    }

    IEnumerator MyCoroutine(float animationLength){

      Debug.Log("MyCoroutine：開始");
      for (float time = 0.0f; time < animationLength; time += Time.deltaTime)
      {
          yield return null;
      }
      Debug.Log("MyCoroutine：終了");
    }

上記のように実装してみたのですが、最初だけMyCoroutineが動いているような挙動を示し、
それ以降はMyCoroutineがスキップされてwhile文でループし続けるような挙動となりました。
以下のようなログとなりました。なぜ、MyCoroutineは1回だけしか動かないのでしょうか。

MyCoroutine：開始
MyCoroutine：終了
while
while
while
while
while
while

・質問2。
コルーチンの停止と終了は、どちらもStopCoroutine()で合っていますか？
StopCoroutine()で停止したコルーチンは、破棄されるという認識で合っていますか？
StopCoroutine()で停止したコルーチンは破棄されるけど、StartCoroutineで再開すると、
停止した箇所から再開されるという認識で合っていますか？
リファレンスには、StopCoroutineに関する、停止・破棄・再開に関する説明は書かれていませんでした。

・質問3。
質問1がわからない状態ですが、コルーチンの無限呼び出しに開始・停止・終了処理の操作ができるようにしたいと
思い、以下の実装を考えてみました。
質問1では、無限に呼び出すコルーチンを汎用的に引数でセットしたいと考えていましたが、
コルーチンの多重起動防止のnullチェックを考えると、そのフラグをフィールドで持たせるしかなさそうなので、
汎用的に無限に呼び出すコルーチンをセットすることは不可能になりそうと考えました(仮に可能であれば教えていただきたいです)。
これより、目的を妥協し、特定のコルーチンの無限呼び出しの開始・停止・終了ができるように以下のように
組みました。ただ、ゲームを再生してみると、
①左クリックで「開始」のログが出ることを確認する。
②右クリックで、「終了」のログが出る前に停止する。
③再び、左クリックすると、「開始」のログが出力される。
という挙動になり、③が意図しない挙動となりました。
本来であれば、②で停止しているので、③では再開に該当し、「終了」のログが出るはずと予想していたのですが、
「開始」のログが出力されてしまいます。
質問2にも関連してきますが、こちらの記事の「コルーチンの一時停止」の説明ににもあるように、
StopCoroutineしたコルーチンを、StartCoroutineすると再開されると思っていたのですが、違うのでしょうか？
また、質問1が未解決の為、検証できてないのですが、
StopCoroutine(myLoopCoroutine)で、中で動かしているMyCoroutineの方も停止できていますか？
MyCoroutineの方までは停止できなかった場合、どのような実装で停止できますか？

    Coroutine myLoopCoroutine;

    void Start (){

    }

    void Update(){
        if (Input.GetMouseButton(0)){
            StartLoopCoroutine(2f);
        }
        if (Input.GetMouseButton(1)){
            StopLoopCoroutine();
        }
    }

    void StartLoopCoroutine(float second){
        if (myLoopCoroutine == null){
            myLoopCoroutine = StartCoroutine(LoopCoroutine(MyCoroutine(second)));
        }
    }

    void StopLoopCoroutine(){
        if (myLoopCoroutine != null){
            StopCoroutine(myLoopCoroutine);
            myLoopCoroutine = null;
        }
    }


    IEnumerator LoopCoroutine(IEnumerator coroutine){
        while(true){
            yield return coroutine;
            Debug.Log("while");
        }
    }

    IEnumerator MyCoroutine(float animationLength){

      Debug.Log("MyCoroutine：開始");
      for (float time = 0.0f; time < animationLength; time += Time.deltaTime)
      {
          yield return null;
      }
      Debug.Log("MyCoroutine：終了");
    }

・質問4。
コルーチンを動かしているスクリプトがアタッチしているゲームオブジェクトを破棄する、
もしくはそのスクリプトコンポーネントを破棄すれば、
そのスクリプト内のコルーチンは、質問1のような入れ子のコルーチンも含めて、全て破棄されるという認識で合っていますか？
こちらは、質問1のスクリプトにおいて、Update()に以下のようなスクリプトやゲームオブジェクトを破棄する処理を書いて試してみた所、
whileのログが停止することが確認できました。
ただ、質問1で入れ子のコルーチンが1回しか動かない状態であることや、ログの停止は確認できていても、
本当にそれでコルーチンを正しく破棄できているか？という疑問があり、念のため、質問させていただきました。

    void Update(){
        if (Input.GetMouseButton(0)){
            // Destroy(this);
            Destroy(this.gameObject);
        }
    }

追記

・質問5で試みた実装。

    IEnumerator myLoopCoroutine;

    bool loopCoroutineIsRunning = false;

    void Start (){
    }

    void Update(){
        if (Input.GetMouseButtonDown(0)){
            // コルーチンを動かす。起動もしくは再開。
            StartLoopCoroutine(2f);
        }
        if (Input.GetMouseButtonDown(1)){
            // コルーチンの停止。
            StopLoopCoroutine();
        }
    }

    void StartLoopCoroutine(float second){
        Debug.Log("Start coroutine");
        if (loopCoroutineIsRunning){
            Debug.LogError("Stop coroutine first!");
            return;
        }
        if (myLoopCoroutine == null){
            myLoopCoroutine = LoopCoroutine();
            StartCoroutine(myLoopCoroutine);
            Debug.Log("New coroutine is started");
        }
        if (myLoopCoroutine != null){
            StartCoroutine(myLoopCoroutine);
            Debug.Log("Resume paused coroutine");
        }
        loopCoroutineIsRunning = true;
    }

    void StopLoopCoroutine(){
        Debug.Log("Stop coroutine");
        if (myLoopCoroutine == null){
            Debug.LogError("Start coroutine first!");
            return;
        }
        if (loopCoroutineIsRunning){
            StopCoroutine(myLoopCoroutine);
        }
        loopCoroutineIsRunning = false;
        Debug.Log("Coroutine is completely stopped");
    }

    IEnumerator LoopCoroutine(){
        while(true){
            yield return MyCoroutine(3f);
        }
    }

    IEnumerator MyCoroutine(float animationLength){
        Debug.Log("MyCoroutine：開始");
        for (float time = 0.0f; time < animationLength; time += Time.deltaTime){
            Debug.Log(time);
            yield return null;
        }
        Debug.Log("MyCoroutine：終了");
    }

Answer 1

質問1について

ご参考になさった「UnityのCoroutine（コルーチン）でできる事のメモ - テラシュールブログ」の「コルーチンの一時停止」に、

なお一度完走したコルーチンを最初からやり直す場合、新しくメソッドからIEnumeratorを取得する必要があります。

との注意書きがありますね。LoopCoroutineの引数のcoroutineはループ1周目で反復処理を完走してしまっているので、2周目以降は何も起こらないんだろうと思います。

コルーチンを最初からやり直すには、IEnumeratorを再作成する必要がありそうです。代替案として下記のような形はどうでしょうか。

// LoopCoroutineの変更に合わせて、StartCoroutine部分を変更する
void Start (){
    StartCoroutine(LoopCoroutine(() => MyCoroutine(3f)));
}

// LoopCoroutineの引数を、IEnumeratorそのものの代わりに
// 「IEnumeratorを生成する手続き」とする
IEnumerator LoopCoroutine(Func<IEnumerator> coroutineProvider){
    while(true){
        yield return coroutineProvider();
        Debug.Log("while");
    }
}

// MyCoroutineは変更なし
IEnumerator MyCoroutine(float animationLength){
    Debug.Log("MyCoroutine：開始");
    for (float time = 0.0f; time < animationLength; time += Time.deltaTime)
    {
        yield return null;
    }
    Debug.Log("MyCoroutine：終了");
}

あるいは下記のようなスタイルも思いついたのですが、こちらだとMyCoroutineの方にも修正を加えることになるため、いまいちかもしれませんね。

// こちらはStartCoroutine部分の形は変化しない
void Start (){
    StartCoroutine(LoopCoroutine(MyCoroutine(3f)));
}

// LoopCoroutineの引数をIEnumerable型に変更し、
// 各ループでIEnumeratorを生成して待機する
IEnumerator LoopCoroutine(IEnumerable coroutineProvider){
    while(true){
        yield return coroutineProvider.GetEnumerator();
        Debug.Log("while");
    }
}

// MyCoroutineの返す型を「IEnumerable」にする
IEnumerable MyCoroutine(float animationLength){
    Debug.Log("MyCoroutine：開始");
    for (float time = 0.0f; time < animationLength; time += Time.deltaTime)
    {
        yield return null;
    }
    Debug.Log("MyCoroutine：終了");
}

質問2について

StartCoroutineの引数として渡すコルーチンの正体はただのIEnumeratorであって、StartCoroutineを実行したMonoBehaviourの側が自動的に適切なタイミングでMoveNextを行うことで順次処理が実行されるのだろうと思います。

StopCoroutineを行うと、この自動的なMoveNext実行がストップするのでしょう。IEnumeratorの側は、そのオブジェクトへのすべての参照がなくならない限りガベージコレクションの対象とはならず、メモリ上に生き残っているはずです。生き残っているIEnumeratorはどこまで処理を進行したかを覚えており、再びそのオブジェクトを引数にStartCoroutineを行うと、最後の中断地点からMoveNextの自動実行が始まるものと思われます。

質問3について

ご提示のコードだとIEnumeratorを再生成する形になっていますね。一時停止した時のIEnumeratorではなく新規にIEnumeratorを作ってStartCoroutineを行っているため、あらためて最初からコルーチンの処理が行われているのかと思います。
下記のような形だとどうでしょうかね?

// 型をIEnumeratorに変える
IEnumerator myLoopCoroutine;

// コルーチンが動作中かどうかを示すフィールドを用意する
bool loopCoroutineIsRunning;

void Start (){
}

void Update(){
    if (Input.GetMouseButtonDown(0)){
        // 左クリックでコルーチンを再開する
        // スペースキーを押しながら左クリックでコルーチンを新規スタートする
        if (Input.GetKey(KeyCode.Space)){
            StartLoopCoroutine(2f);
        }else{
            ResumeLoopCoroutine();
        }
    }
    if (Input.GetMouseButtonDown(1)){
        // 右クリックでmyLoopCoroutineを一時停止する
        // スペースキーを押しながら右クリックでmyLoopCoroutineを停止する
        if (Input.GetKey(KeyCode.Space)){
            StopLoopCoroutine();
        }else{
            PauseLoopCoroutine();
        }
    }
}

void StartLoopCoroutine(float second){
    Debug.Log("Start new coroutine");
    if (myLoopCoroutine != null){
        Debug.Log("Stop previous coroutine");
        StopLoopCoroutine();
    }
    myLoopCoroutine = LoopCoroutine(() => MyCoroutine(second));
    loopCoroutineIsRunning = true;
    StartCoroutine(myLoopCoroutine);
    Debug.Log("New coroutine is started");
}

void PauseLoopCoroutine(){
    Debug.Log("Pause running coroutine");
    if (myLoopCoroutine == null){
        Debug.LogError("Start coroutine first!");
        return;
    }
    if (!loopCoroutineIsRunning){
        Debug.LogError("Start or resume coroutine first!");
        return;
    }
    StopCoroutine(myLoopCoroutine);
    loopCoroutineIsRunning = false;
    Debug.Log("Coroutine is paused");
}

void ResumeLoopCoroutine(){
    Debug.Log("Resume paused coroutine");
    if (myLoopCoroutine == null){
        Debug.LogError("Start coroutine first!");
        return;
    }
    if (loopCoroutineIsRunning){
        Debug.LogError("Pause coroutine first!");
        return;
    }
    StartCoroutine(myLoopCoroutine);
    loopCoroutineIsRunning = true;
    Debug.Log("Coroutine is resumed");
}

void StopLoopCoroutine(){
    Debug.Log("Stop coroutine");
    if (myLoopCoroutine == null){
        Debug.LogError("Start coroutine first!");
        return;
    }
    if (loopCoroutineIsRunning){
        StopCoroutine(myLoopCoroutine);
    }
    myLoopCoroutine = null;
    loopCoroutineIsRunning = false;
    Debug.Log("Coroutine is completely stopped");
}

IEnumerator LoopCoroutine(Func<IEnumerator> coroutineProvider){
    while(true){
        yield return coroutineProvider();
        Debug.Log("while");
    }
}

IEnumerator MyCoroutine(float animationLength){
    Debug.Log("MyCoroutine：開始");
    for (float time = 0.0f; time < animationLength; time += Time.deltaTime){
        Debug.Log(time);
        yield return null;
    }
    Debug.Log("MyCoroutine：終了");
}

なお、LoopCoroutineやMyCoroutineは「質問1について」で例示したコードのうちの前者と同じ形にしています。
また注意点として、一時停止したあと再開する場合はコルーチンの1段目...つまりLoopCoroutineの中断地点からの再開となってしまい、その中で実行させていたはずのMyCoroutineの中断地点から再開することはできないようですね（中断地点が失われてしまっているのを明確にするため、MyCoroutine内でコンソールにtimeを出力するよう改変しています）。

この問題を回避するとなるとどうやらやっかいそうで、おそらく自前でコルーチン実行システムを作り、MoveNext実行を詳しく制御する必要があるかもしれません...

質問4について

「コルーチン - Unity マニュアル」に...

Note: You can stop a Coroutine with StopCoroutine and StopAllCoroutines. A coroutines also stops when the GameObject it is attached to is disabled with SetActive(false). Calling Destroy(example) (where example is a MonoBehaviour instance) immediately triggers OnDisable and the coroutine is processed, effectively stopping it. Finally, OnDestroy is invoked at the end of the frame.

Coroutines are not stopped when disabling a MonoBehaviour by setting enabled to false on a MonoBehaviour instance.

との記述がありました。ですので、オブジェクトを破棄すればコルーチンは停止し、他のスクリプトでそのゲームオブジェクトやコンポーネントを参照している変数がなければC#スクリプト上のGameObjectやMonoBehaviourもやがて解放され、スクリプトコンポーネント上で使用していたIEnumeratorへの参照も失われて解放対象になるだろうと思います。

使用していたIEnumeratorが別のスクリプトからも参照されていれば解放されることはないでしょうが、一般的なコルーチンの使用方法では生成したIEnumeratorを外へ持ち出して参照を保持し続けておくようなことはしないでしょうから、お気になさる必要はないかと思います。
仮にそのような状況になってIEnumeratorがメモリ上に生き残っていたとしても、メモリは少々占有し続けるでしょうが、コルーチンは停止していますので処理上の負荷はかからないだろうと思います。

Comments

[退会済みユーザー]

ご回答ありがとうございます。
コメントが遅くなり申し訳ございません。
コードを考えるのに時間がかかってしまいました。

・質問1について。
　コルーチンを最初からやり直す方法のご教示ありがとうございます。
　理解できました。

・質問2について。
　なるほど、StopCoroutineだけでは破棄にまでは至らず、コルーチンの終了とはならないわけですね。
　また、質問4のご回答で「コルーチンは停止していますので処理上の負荷はかからないだろう思います」
　とのことで、
　そのコルーチンを2度と呼び出すことがないとわかっていても、完全な破棄まではせずに、
　そのコルーチンの終了処理は、StopCoroutineで止めておく程度でも問題ないでしょうか？
　それとも、ガベージコレクションの対象になるように処理したほうがよいでしょうか？
　その場合は、StopCoroutineで止めて、コルーチンを参照していたmyLoopCoroutineをnullにすれば、
　ガベージコレクションの対象になるということでしょうか？

・質問3について。
　ご回答ありがとうございます。
　ご提示いただいたコードを試して、それぞれの動作を確認いたしました。
　ご教示ありがとうございます。

・質問4について。
　ご回答ありがとうございます。
　基本的には、オブジェクトを破棄すれば、コルーチンの終了として問題ないということですね。
　すみません、念の為確認させていただきたいのですが、ゲームオブジェクトの破棄だけでなく、
　スクリプトコンポーネントの破棄も、オブジェクトの破棄に含まれるということでしょうか？
　(スクリプトコンポーネントの破棄でも、コルーチンの終了として問題ないということでしょうか？

・質問5。
　質問が1点増えてしまい、申し訳ございません。
　以下の仕様の処理も、使う用途がありそうなので、実装してみたいと思い、
　ご教示いただいた質問3のコードを参考に実装を試みたのですが、
　コードとしておかしい箇所や改善点はありますか？
　質問の追記欄にコードを記載しました。
　(仕様)
・特定のコルーチン(決め打ちのコルーチン)の繰り返し処理を行う。
・開始・停止・再開の実装。
　(終了は停止で問題ない(破棄までする必要はない)と仮定しています)。
・操作としては、以下の2つ。
　コルーチンを動かす(起動していなければ起動し、停止中であれば再開)。
　コルーチンを止める。
・多重起動を防止する。

　試したところ、問題はなさそうでしたが、何か見落としている箇所があるかもしれないと思い、
　質問させていただきました。
　質問3でも確認しましたが、StopCoroutineで、LoopCoroutineだけではなく、
　入れ子のMyCoroutineまで停止ができてしまうのですね。
　一時停止したコルーチンは再開時に、入れ子のMyCoroutineは途中から再開できない(実装が大変)という点は承知しました。

[Bongo]

質問2について

私の考えでは、普通はStopCoroutineで止めておくだけで十分かと思います。確かにおっしゃる通りmyLoopCoroutineをnullにすればガベージコレクションの対象になるはずですが、この程度の小さなオブジェクト1個のためにそこまで神経質になることはないんじゃないでしょうか。
チリも積もれば...なんて言葉もありますが、優先して対処するべきなのは「チリが削除されないまま蓄積され続ける構造になっている」とか「短時間で大量のチリが発生して簡単に山になる」とか「チリどころではない巨大廃棄物」だとかのケースでしょう。

質問4について

そうですね。回答中のマニュアルの引用部分に「Destroy(example) (where example is a MonoBehaviour instance)」との言葉が出てきますが、ゲームオブジェクトは破棄せずにスクリプトコンポーネントだけを破棄した場合でも、そのスクリプトコンポーネント上で開始したコルーチンは停止するようです（念のためちょこっと試してみましたが、ちゃんとそのような挙動になっていました）。

質問5について

見たところ深刻な問題を起こしそうな部分はなさそうに思いました。あえて申し上げるとすると...

void StartLoopCoroutine(float second){
Debug.Log("Start coroutine");
if (loopCoroutineIsRunning){
Debug.LogError("Stop coroutine first!");
return;
}
if (myLoopCoroutine == null){
myLoopCoroutine = LoopCoroutine();
StartCoroutine(myLoopCoroutine);
Debug.Log("New coroutine is started");
}
if (myLoopCoroutine != null){
StartCoroutine(myLoopCoroutine);
Debug.Log("Resume paused coroutine");
}
loopCoroutineIsRunning = true;
}

の部分でしょうかね?
新規にコルーチンをスタートする場合、まず「if (myLoopCoroutine == null){」のブロックでmyLoopCoroutineに新規コルーチンをセットおよびスタートし、これによりmyLoopCoroutineがnullでなくなるので、その下の「if (myLoopCoroutine != null){」のブロックも常に実行されることになるでしょう。
同じIEnumeratorオブジェクトに対して2回連続でStartCoroutineを行っても、どうやら二重にスタートしてしまうことはなさそうなので動作上は問題ないようですが、ちょっと紛らわしいかもしれません。下記のような形でもいいんじゃないでしょうか。

void StartLoopCoroutine(float second){
Debug.Log("Start coroutine");
if (loopCoroutineIsRunning){
Debug.LogError("Stop coroutine first!");
return;
}
if (myLoopCoroutine == null){
myLoopCoroutine = LoopCoroutine();
Debug.Log("New coroutine is started");
}else{
Debug.Log("Resume paused coroutine");
}
StartCoroutine(myLoopCoroutine);
loopCoroutineIsRunning = true;
}

また、引数のsecondは使用されていないようです。今後使うつもりでしたらかまわないのですが、引数が不要なら削除してしまった方が紛らわしくないんじゃないかと思います。

[退会済みユーザー]

ご回答ありがとうございます。

・質問2について。
　コルーチンの終了についてのご教示ありがとうございます。
　理解しました。勉強になります。

・質問4について。
　スクリプトコンポーネントの破棄でも、コルーチンの終了として問題ないこと承知しました。
　ご教示ありがとうございます。

・質問5について。
　StartLoopCoroutineのmyLoopCoroutineのセット後に、無駄に後のif文に引っ掛かってしまう件、
　ご指摘ありがとうございます。こちら全然気づきませんでした。
　修正案のご教示もありがとうございます。
　StartCoroutineを最後に1回だけ呼び出して、コードが簡略化できているわけですね。
　とても勉強になります。
　また、StartLoopCoroutineの引数のsecondは間違って付与していました。
　ご指摘ありがとうございます。

全ての疑問点が解決しました。
とても勉強になりました。
たくさんのご教示大変ありがとうございました。

Answer 2

そのコルーチンの終了時に StartCoroutineを呼んでやればいいだけなんでは