IEnumerator型に代入したコルーチンは一度しか実行出来ない件について

Question

ボタンイベントを登録してコルーチンを呼び出す際、
IEnumerator型に代入して呼び出すと最初の一回しか呼び出せないのはどういった理由からでしょうか？

下記の様にボタン二つを用意して同じコルーチンを「そのまま呼び出す」、「代入して呼び出す」を試しましたが後者の方は一回しか呼び出せません。

using UnityEngine;
using System.Collections;
using UnityEngine.UI;

public class TestCode : MonoBehaviour
{
    [SerializeField]
    Button[] button = null;

    private void Start()
    {
        IEnumerator enumerator = CorutineTest();

        button[ 0 ].onClick.AddListener( () => StartCoroutine( CorutineTest() ) ); // 何度も呼び出せる
        button[ 1 ].onClick.AddListener( () => StartCoroutine( enumerator ) ); // 一度しか呼び出せない
    }

    IEnumerator CorutineTest()
    {
        Debug.Log( "A" );
        yield return null;
    }
}

UnityAction型での関数呼び出しではこういった違いが無いのは確認しています。
UnityActionはdelegate、IEnumeratorはinterfaceなのでこの辺りの違いから発生している事かと調べていますが詳しい記述がヒットしないので質問させて頂きました。

bboydaisukeさんの回答を受けての追記：デリゲートでの記述

bboydaisukeさんが提示してくれたサイトを参考にコルーチン用のデリゲートを用意してそれに代入して呼び出すように変更すれば問題無く複数回呼び出せるようになりました。

内部的処理の説明などまだ完璧では無いですが対処法は今後大丈夫そうです。

using UnityEngine;
using System.Collections;
using UnityEngine.UI;

public class TestCode : MonoBehaviour
{
    [SerializeField]
    Button[] button = null;

    private delegate IEnumerator CoroutineDelegate();

    private void Start()
    {
        CoroutineDelegate corutineDelegate = CorutineTest;

        button[ 0 ].onClick.AddListener( () => StartCoroutine( CorutineTest() ) ); // 何度も呼び出せる
        button[ 1 ].onClick.AddListener( () => StartCoroutine( corutineDelegate () ) ); // 何度も呼び出せる
    }

    IEnumerator CorutineTest()
    {
        Debug.Log( "A" );
        yield return null;
    }
}

katsukoさんの回答を受けての結論

コルーチンはプログラムを任意の箇所で中断・再開するしくみという認識が正確に出来ていなかったようです。

() => StartCoroutine( CorutineTest() )は毎回初期位置に戻って呼び出されるのでDebug.Logが呼ばれる。
() => StartCoroutine( enumerator )は初期位置に戻らないのでDebug.Logが呼ばれない。

上記動作の違いがある為に差異が発生していました。

Answer 1

回答を書いている間に解決しちゃったけど、せっかくなのであげておきますね。

まず、「C# IEnumerator」でググって、IEnumeratorについて理解してください。
簡単に説明すると、「MoveNextメソッドで次々に列挙して、Currentプロパティで値を取得するインターフェイス」です。

さて、yield文を含むメソッドを呼び出すと一体何を返すかというと、MoveNextメソッドを呼び出すたびにyield文まで実行し、Currentプロパティでyield文で返した値を取得するIEnumeratorインターフェイスを実装したインスタンスを返します。
試しに、以下のスクリプトを実行してみます。

using UnityEngine;
using System.Collections;

public class Test01 : MonoBehaviour {
	IEnumerator Func()
	{
		Debug.Log("Point 1.");
		yield return 1;
		Debug.Log("Point 2.");
		yield return 2;
		Debug.Log("Point 3.");
		yield return 3;
		Debug.Log("Point 4.");
	}

	void Start()
	{
		Debug.Log("Point A.");
		IEnumerator e = Func();
		Debug.Log("Point B.");
		while (e.MoveNext()) {
			Debug.LogFormat("Point C, {0}.", e.Current);
		}
		Debug.Log("Point D.");
	}
}

ログは、以下のように出力されます。

Point A.
Point B.
Point 1.
Point C, 1.
Point 2.
Point C, 2.
Point 3.
Point C, 3.
Point 4.
Point D.

ここまで理解すると、コルーチンがどのように実装されているか、見えてくるのではないでしょうか。
nullしか返さないコルーチンであれば、StartCoroutineを呼ばなくても、以下のように実装できます。

using UnityEngine;
using System.Collections;

public class Test01 : MonoBehaviour {
	IEnumerator Func()
	{
		Debug.Log("Point 1.");
		yield return 1;
		Debug.Log("Point 2.");
		yield return 2;
		Debug.Log("Point 3.");
		yield return 3;
		Debug.Log("Point 4.");
	}

	IEnumerator enumerator;

	void Start()
	{
		this.enumerator = Func();
	}

	void Update()
	{
		if (this.enumerator != null) {
			if (!this.enumerator.MoveNext()) {
				this.enumerator = null;
			}
		}
	}
}

以上の事を踏まえ、質問文に戻ります。

        button[ 0 ].onClick.AddListener( () => StartCoroutine( CorutineTest() ) ); // 何度も呼び出せる

この場合は、ボタンが押されるたびにIEnumeratorを作成しているので、最初から実行されます。

        IEnumerator enumerator = CorutineTest();
        button[ 1 ].onClick.AddListener( () => StartCoroutine( enumerator ) ); // 一度しか呼び出せない

この場合は、IEnumeratorはStartメソッドが呼ばれたときのみ作成されます。
ですので、Resetメソッドを呼ばない限り最初から実行されません。

Comments

[Hawn]

英文でもそれなりに理解出来たつもりで早い段階でBA決めさせて頂きましたが、
こちら日本語で詳細に説明して頂き十分に理解出来ました。

MoveNextを使ってテストしていくと理解早かったようです。

今までコルーチンは処理の待ち合わせで結構使っていたのですが完璧ではない理解度だったと身に沁みました。
ありがとうございました。

[Zuishin]

Reset メソッドは使ってはいけません。あまりにも使われないので実装されない場合、またバージョンアップによって突然実装されなくなる場合があります。

[Hawn]

知見として見やすいように結論を記述して上がってしまったのかと思いますがコメントありがとうございます。
Reset メソッドに関しては質問前にも試して"NotSupportedException: Specified method is not supported."が発生するのは確認していました。

これが機能していれば「コルーチン用のデリゲートを用意」という対処しなくて良かったのですが何の為に存在しているメソッドなのでしょう？

[Zuishin]

元々は役に立つはずだったメソッドじゃないかと思っていますが、IEnumerable があるために無用の長物と化していますね。今更削除できないので残っているだけだと思います。

[Hawn]

誰からも必要とされていないのに放置されているだけなのですか。
悲しみしかないです。

[katsuko]

Zuishinさん、ありがとうございます。

自分も調べて、こんな記事を見つけました。
http://blogs.wankuma.com/shannon/archive/2007/07/10/84596.aspx

Answer 2

答えが正しいかは判断できませんが...。

Problem storing a coroutine in IEnumerator type variable - only works once?

Comments

[Hawn]

ありがとうございます。
質問した後そちらの記事を丁度見ていたところでした。

「同じインスタンスをStartCoroutineに渡し、Unityが最終的にMoveNextを呼び出すと、それはすでに最終状態にあるため、何も実行されません。」との記述があるので同じインスタンスを参照する後者の方では状態が戻らない事が原因みたいでした。

直接呼び出しの方は毎回生成で初期に戻るので何度でも呼び出して問題ないといった感じでしょうか。

言語化して人に説明出来るレベルでは無いですが大筋理解出来ました。