using System.Collections;
using UnityEngine;

namespace Funique
{
    /// <summary>
    /// Library code does not inherits <seealso cref="MonoBehaviour"/> <br />
    /// Which means these class does not have way to access <seealso cref="Coroutine"/> feature that unity provide <br />
    /// To improve this problem, We add a singleton monoBehaviour script to do all <seealso cref="Coroutine"/> work <br />
    /// ------------------------------------------------ <br/>
    /// 程式庫的代碼並非繼承 <seealso cref="MonoBehaviour"/> <br />
    /// 這代表這些類別無法存取 Unity 的執行 <seealso cref="Coroutine"/> 協程函式 <br/>
    /// 解決這個問題, 在場景加入一個獨立靜態物件來運行所有 <seealso cref="Coroutine"/> 函式
    /// </summary>
    public class CoroutineHelper : MonoBehaviour
    {
        public static CoroutineHelper Instance;

        private void Awake() { Instance = this; }

        /// <summary>
        /// Start running a coroutine method
        /// ------------------------------------------------ <br/>
        /// 開始協程
        /// </summary>
        /// <param name="method"></param>
        /// <returns></returns>
        public Coroutine Run(IEnumerator method)
        {
            return StartCoroutine(method);
        }
        /// <summary>
        /// Stop a coroutine <br />
        /// ------------------------------------------------ <br/>
        /// 殺死協程
        /// </summary>
        /// <param name="method">Target coroutine</param>
        public void Stop(Coroutine method)
        {
            StopCoroutine(method);
        }
        /// <summary>
        /// Stop a coroutine by method <br />
        /// It will kill the first one <br />
        /// ------------------------------------------------ <br/>
        /// 根據函式停止協程 <br />
        /// 會殺死第一個生成的並存活的
        /// </summary>
        /// <param name="method"></param>
        public void Stop(IEnumerator method)
        {
            StopCoroutine(method);
        }
        /// <summary>
        /// Kill all coroutines <br />
        /// ------------------------------------------------ <br/>
        /// 殺死所有協程
        /// </summary>
        public void StopAll()
        {
            StopAllCoroutines();
        }
    }
}