Что возвращает Coroutine?

Что возвращает Coroutine?

В контексте движка Unity, корутина (Coroutine) — это специальный метод, который может приостанавливать своё выполнение, возвращая управление основной игровой логике, и затем возобновляться с того же места. Ключевой момент: корутина возвращает объект типа YieldInstruction или его производных.

Точный тип возвращаемого значения — IEnumerator. Это интерфейс, который позволяет использовать ключевое слово yield return для управления потоком выполнения. При вызове через StartCoroutine(), Unity внутренне обрабатывает этот итератор, выполняя код до каждого yield return.

Основные типы возвращаемых значений (Yield Instructions)

• yield return null; — Приостанавливает выполнение до следующего кадра, до вызова Update().
• yield return new WaitForSeconds(float time); — Пауза на заданное количество секунд (игрового времени, зависит от Time.timeScale).
• yield return new WaitForSecondsRealtime(float time); — Пауза на время, не зависящее от Time.timeScale (реальное время).
• yield return new WaitForFixedUpdate(); — Приостанавливает выполнение до следующего вызова FixedUpdate() (полезно для работы с физикой).
• yield return new WaitForEndOfFrame(); — Пауза до момента, после отрисовки всего кадра (полезно для скриншотов).
• yield return new WaitUntil(System.Func<bool> predicate); — Ожидание, пока переданная функция-условие не вернёт true.
• yield return new WaitWhile(System.Func<bool> predicate); — Ожидание, пока переданная функция-условие возвращает true.
• yield return StartCoroutine(anotherCoroutine); — Ожидание завершения выполнения другой корутины. Это позволяет создавать цепочки и вложенные асинхронные операции.
• yield return new WaitForSeconds(0); или yield return null; после ресурсоёмкой операции — Классический паттерн для распределения нагрузки, чтобы не блокировать основной поток на кадр.

Практический пример использования

Рассмотрим корутину, которая плавно перемещает объект:

using System.Collections;
using UnityEngine;

public class Mover : MonoBehaviour
{
    public IEnumerator MoveToTarget(Vector3 target, float duration)
    {
        Vector3 startPosition = transform.position;
        float elapsedTime = 0f;

        while (elapsedTime < duration)
        {
            // Логика интерполяции выполняется каждый кадр
            transform.position = Vector3.Lerp(startPosition, target, elapsedTime / duration);
            elapsedTime += Time.deltaTime;

            // Здесь корутина возвращает `null`, приостанавливаясь до следующего кадра
            yield return null;
        }

        // Финальное присваивание для точности
        transform.position = target;
        // По завершении цикла итератор заканчивает работу
    }

    void Start()
    {
        // StartCoroutine принимает IEnumerator и управляет его выполнением
        StartCoroutine(MoveToTarget(new Vector3(10, 0, 0), 2.0f));
    }
}

Важные технические детали

• StartCoroutine() возвращает Coroutine — это объект-дескриптор, который можно использовать для остановки корутины методом StopCoroutine().
• Корутина не возвращает результат в традиционном смысле (как, например, int). Её цель — не вычисление значения, а организация распределённого во времени процесса.
• Все yield-инструкции являются объектами. Например, WaitForSeconds кэшируется внутри Unity для оптимизации, чтобы не создавать новый объект при каждом вызове.
• При уничтожении объекта (GameObject), к которому прикреплён скрипт, или при выключении (SetActive(false)) монобеhaviour, все запущенные на нём корутины автоматически останавливаются.

Итог: Корутина возвращает IEnumerator, который с помощью различных объектов типа YieldInstruction (возвращаемых оператором yield return) сообщает движку Unity, когда ей следует продолжить выполнение. Это мощный механизм для реализации асинхронного поведения, таймеров, анимаций и последовательностей действий без блокировки основного игрового потока.