что такое корутины unity
Работа с Корутинами в Unity
Корутины (Coroutines, сопрограммы) в Unity — простой и удобный способ запускать функции, которые должны работать параллельно в течение некоторого времени. В работе с корутинами ничего принципиально сложного нет и интернет полон статей с поверхностным описанием их работы. Тем не менее, мне так и не удалось найти ни одной статьи, где описывалась бы возможность запуска группы корутинов с продолжением работы после их завершения.
Хочу предложить вам небольшой паттерн, реализующий такую возможность, а также подбор информации о корутинах.
Корутины представляют собой простые C# итераторы, возвращающие IEnumerator и использующие ключевое слово yield. В Unity корутины регистрируются и выполняются до первого yield с помощью метода StartCoroutine. Дальше Unity опрашивает зарегистрированные корутины после каждого вызова Update и перед вызовом LateUpdate, определяя по возвращаемому в yield значению, когда нужно переходить к следующему блоку кода.
Существует несколько вариантов для возвращаемых в yield значений:
Продолжить после следующего FixedUpdate:
Продолжить после следующего LateUpdate и рендеринга сцены:
Продолжить через некоторое время:
Продолжить по завершению другого корутина:
Продолжить после загрузки удаленного ресурса:
Все прочие возвращаемые значения указывают, что нужно продолжить после прохода текущей итерации цикла Update:
Выйти из корутина можно так:
При использовании WaitForSeconds создается долгосуществующий объект в памяти (управляемой куче), поэтому его использование в быстрых циклах может быть плохой идеей.
Я уже написал, что корутины работают параллельно, следует уточнить, что они работают не асинхронно, то есть выполняются в том же потоке.
Простой пример корутина:
Этот код запускает корутин с циклом, который будет писать в консоль время, прошедшее с последнего фрейма.
Следует обратить внимание на то, что в корутине сначала вызывается yield return null, и только потом идет запись в лог. В нашем случае это имеет значение, потому что выполнение корутина начинается в момент вызова StartCoroutine(TestCoroutine()), а переход к следующему блоку кода после yield return null будет осуществлён после метода Update, так что и до и после первого yield return null Time.deltaTime будет указывать на одно и то же значение.
Также нужно заметить, что корутин с бесконечным циклом всё еще можно прервать, вызвав StopAllCoroutines(), StopCoroutine(«TestCoroutine»), или уничтожив родительский GameObject.
Хорошо. Значит с помощью корутинов мы можем создавать триггеры, проверяющие определенные значения каждый фрейм, можем создать последовательность запускаемых друг за другом корутинов, к примеру, проигрывание серии анимаций, с различными вычислениями на разных этапах. Или просто запускать внутри корутина другие корутины без yield return и продолжать выполнение. Но как запустить группу корутинов, работающих параллельно, и продолжить только по их завершению?
Конечно, вы можете добавить классу, в котором определен корутин, переменную, указывающую на текущее состояние:
Класс, который нужно двигать:
Класс, работающий с группой классов, которые нужно двигать:
Блок «делаем еще дела» начнет выполнятся после завершения корутина MoveCoroutine у каждого объекта в массиве objectsToMove.
Что ж, уже интересней.
А что, если мы хотим создать группу корутинов, с возможностью в любом месте и в любое время проверить, завершила ли группа работу?
Сделаем!
Для удобства сделаем всё в виде методов расширения:
Кастомные корутины в Unity с преферансом и куртизанками
Вы уже настолько круты, что вертите корутинами вокруг всех осей одновременно, от одного вашего взгляда они выполняют yield break и прячутся за полотно IDE. Простые обертки — давно пройденный этап.
Вы настолько хорошо умеете их готовить, что могли бы получить звезду Мишлена (а то и две), будь у вас свой ресторан. Конечно! Никто не останется равнодушным, отведав ваш Буйабес с корутинным соусом.
Уже целую неделю код в проде не падает! Обертки, callback ’и и методы Start/Stop Coroutine — удел холопов. Вам нужно больше контроля и свободы действий. Вы готовы подняться на следующую ступеньку (но не бросить корутины, конечно).
Если в этих строках вы узнали себя, — добро пожаловать под кат.
Пользуясь случаем, хочу передать привет одному из моих любимых паттернов — Command.
Введение
Для кастомных yield инструкций Unity предоставляет одноименный класс CustomYieldInstruction (docs).
Достаточно лишь наследоваться от него и реализовать свойство keepWaiting. Его логику мы уже обсудили выше. Оно должно возвращать true до тех пор, пока корутина должна выполняться.
Пример из документации:
Если вы работаете с кодом, в котором определенные вещи должны сработать в конкретный момент, и до сих пор не изучили вот эту страницу — настоятельно рекомендую решиться на сей подвиг.
Кастомные yield инструкции
Но мы же с вами сюда пришли не очередные обертки на подобие CustomYieldInstruction наследовать. За такое можно и без Мишлена остаться.
Потому курим дальше документацию и практически на дне всё той же страницы находим самый важный абзац.
To have more control and implement more complex yield instructions you can inherit directly from System.Collections.IEnumerator class. In this case, implement MoveNext() method the same way you would implement keepWaiting property. Additionally to that, you can also return an object in Current property, that will be processed by Unity’s coroutine scheduler after executing MoveNext() method. So for example if Current returned another object inheriting from IEnumerator , then current enumerator would be suspended until the returned one has completed.
Чтобы получить больше контроля и реализовать более комплексные yield инструкции, вы можете наследоваться непосредственно от интерфейса System.Collections.IEnumerator . В этом случае, реализуйте метод MoveNext() таким же образом, как свойство keepWaiting . Кроме этого, вы можете использовать объект в свойстве Current , который будет обработан планировщиком корутин Unity после выполнения метода MoveNext() . Например, если свойство Current возвращает другой объект реализующий интерфейс IEnumerator , выполнение текущего перечислителя будет отложено, пока не завершится выполнение нового.
Святые моллюски! Это же те контроль и свобода действий, которых так хотелось. Ну всё, теперь то вы так корутинами завертите, что никакой Gimbal Lock не страшен. Главное, от счастья, прод с вертухи не грохнуть.
Интерфейс
Что ж, было бы неплохо начать с того, чтобы определиться, какой интерфейс взаимодействия с нашей инструкцией мы хотим иметь. Некий минимальный набор.
Предлагаю следующий вариант
Хочу обратить ваше внимание, что здесь IsExecuting и IsPaused не противоположные вещи. Если выполнение корутины на паузе, она всё еще выполняется.
Пасьянс и куртизанки
Стоит учитывать, что есть как минимум два способа, которыми наша инструкция может быть запущена:
Метод StartCoroutine(IEnumerator routine) :
Также, методы для обработки событий в дочерних классах:
Они будут вызываться вручную непосредственно перед соответствующими событиями, чтобы предоставить дочерним классам приоритет их обработки.
Теперь оставшиеся методы.
Здесь всё просто. Инструкцию можно поставить на паузу только в том случае, если она выполняется и если ещё не приостановлена, и продолжить выполнение, только если оно приостановлено.
Основной метод запуска тоже крайне прост — запуск будет произведен только в том случае, если инструкция еще не запущена.
И самое интересное, но от этого не более сложное, — MoveNext :
if (!Update()) — метод Update в наших инструкциях будет работать точно так же, как keepWaiting в CustomYieldInstruction и должен быть реализованным в дочернем классе. В Instruction это просто абстрактный метод.
Примеры
Базовый класс готов. Для создания любых инструкций достаточно наследовать его и реализовать необходимые члены. Предлагаю взглянуть на несколько примеров.
Как сделать корутины в Unity немного удобнее
Каждый разработчик находит свои преимущества и недостатки использования корутин в Unity. И сам решает в каких сценариях их применить, а в каких отдать предпочтение альтернативам.
В повседневной практике я достаточно часто использую корутины для различных видов задач. Однажды, я понял, что именно меня в них раздражает и отторгает многих новичков.
Кошмарный интерфейс
Движок предоставляет всего пару методов и несколько их перегрузок для работы с корутинами:
Запуск (docs)
Остановка (docs)
Перегрузки со строковыми параметрами (не смотря на их обманчивое удобство) можно сразу отправить на помойку забыть как минимум по трем причинам.
С одной стороны, предоставленных методов вполне достаточно, чтобы покрыть базовые потребности. Но со временем я начал замечать, что при активном использовании приходится писать большое количество шаблонного кода — это утомляет, и ухудшает его читаемость.
Ближе к сути
В этой статье я хочу описать небольшую обертку, которую я применяю уже давно. Благодаря ей, с мыслями о корутинах у меня в голове больше не возникают фрагменты шаблонного кода, с которым приходилось вокруг них плясать. Кроме этого, всей команде стало проще читать и понимать компоненты, где используются корутины.
Допустим, перед нами стоит следующая задача — написать компонент, который позволяет перемещать объект к заданной точке.
В данным момент не играет роли, каким именно методом будет выполняться передвижение и в каких координатах. Мной будет выбран лишь один из множества вариантов — это интерполяция и глобальные координаты.
Стандартная реализация
Предлагаю следующий вариант реализации необходимого компонента:
В методе Move очень важно запускать корутину только в тому случае, когда она еще еще не запущена. Иначе их можно будет запустить сколько угодно и каждая из них будет перемещать объект.
threshold — допуск. Другими словами, расстояние к точке, приблизившись на которое мы будем считать, что достигли цели.
Для чего это нужно
Мы проверяем расстояние к цели на больше/меньше, что позволяет нам избежать данной проблемы.
Пока что это всё, наш компонент достаточно прост. И в текущий момент никаких проблем нет. Но, что это за компонент, позволяющий двигать объект к точке, но не предоставляющий возможность его остановить. Давайте исправим эту несправедливость.
Так как мы с вами решили не переходить на сторону зла, и не использовать перегрузки со строковыми параметрами, теперь нам нужно сохранить где-то ссылку на запущенную корутину. Иначе как потом остановить её?
Добавим метод остановки движения:
Совсем другое дело! Хоть к ране прикладывай.
Итак. Мы имеем небольшой компонент, который выполняет поставленную задачу. В чем же моё негодование?
Проблемы и их решение
Со временем, проект растёт, а вместе с ним и количество компонентов, в том числе использующих корутины. И с каждым разом мне всё больше не дают покоя вот какие вещи:
Один их вид заставляет мой глаз дергаться, да и читать такой код сомнительное удовольствие (согласен, бывает и хуже). Но ведь куда приятнее и нагляднее было бы иметь что-нибудь в таком роде:
Иначе, по причине отсутствия ссылки на корутину, вы попросту не сможете ее остановить.
Если забудете, то получите одноразовую корутину. После первого запуска в moveRoutine так и останется ссылка на корутину, и новую запустить уже не выйдет.
Точно так же нужно сделать и в случае принудительной остановки:
Давайте же наконец-то это сделаем!
Routine — делегат, с которым будет сообщен метод, выполняющий роль корутины.
IsProcessing — позволяет узнать, выполняется ли корутина в текущий момент.
Таким образом мы избавляемся от большого количества головной боли, а наш компонент приобретает совсем другой вид:
Осталась лишь сама корутина и несколько строчек кода для работы с ней. Значительно лучше.
Допустим, пришла новая задача — нужно добавить возможность выполнить любой код после того, как объект достиг цели.
В изначальном варианте нам пришлось бы в каждую корутину добавлять дополнительный параметр-делегат, который можно дернуть по ее завершении.
И вызывать следующим образом:
А если еще в качестве обработчика будет какая-нибудь лямбда, то смотрится еще страшнее.
С нашей же оберткой достаточно лишь один раз добавить в нее это событие.
А затем, при необходимости, подписаться.
Полагаю, вы уже обратили внимание на то, что текущий вариант обертки предоставляет возможность работать только с корутинами без параметров. Поэтому мы можем написать обобщенную обертку для корутин с одним параметром. Остальные делаются по аналогии.
Но, по хорошему, было бы неплохо сначала вынести код, который будет одинаковым для всех оберток, в какой-то базовый класс, чтобы не писать одно и то же. Мы ведь с этим и боремся.
И теперь, собственно говоря, обертка для корутин с одним параметром:
Как видим, код практически такой же. Лишь в некоторых местах добавились фрагменты, зависящие от количества аргументов.
Есть множество вариантов, как можно еще больше расширить функциональность этой обертки: добавить запуск с задержкой, события с параметрами, возможное отслеживание прогресса корутины и прочее. Но я предлагаю на этом этапе остановиться.
Цель данной статьи — желание поделиться насущными проблемами, с которыми я столкнулся и предложить вариант их решения, а не покрыть возможные потребности всех разработчиков.
Надеюсь, как новички, так и опытные товарищи почерпнут пользу из моего опыта. Возможно, поделятся своим в комментариях или укажут на ошибки, которые я мог допустить.
Coroutines
Когда вы вызываете функцию, она должна полностью выполниться, прежде чем вернуть какое-то значение. Фактически, это означает, что любые действия, происходящие в функции, должны выполниться в течение одного кадра; вызовы функций не пригодны для, скажем, процедурной анимации или любой другой временной последовательности. В качестве примера мы рассмотрим задачу по уменьшению прозрачности объекта до его полного исчезновения.
Как можно заметить, функция Fade не имеет визуального эффекта, который мы хотели получить. Для скрытия объекта нам нужно было постепенно уменьшить прозрачность, а значит иметь некоторую задержку для того, чтобы были отображены промежуточные значения параметра. Однако функция выполняется в полном объеме, за одно обновление кадра. Промежуточные значения, увы, не будут видны и объект исчезнет мгновенно.
С подобными ситуациями можно справиться, добавив в функцию Update код, изменяющий прозрачность кадр за кадром. Однако для подобных задач зачастую удобнее использовать корутины.
A coroutine is like a function that has the ability to pause execution and return control to Unity but then to continue where it left off on the following frame. In C#, a coroutine is declared like this:
It is essentially a function declared with a return type of IEnumerator and with the yield return statement included somewhere in the body. The yield return line is the point at which execution will pause and be resumed the following frame. To set a coroutine running, you need to use the StartCoroutine function:
In UnityScript, things are slightly simpler. Any function that includes the yield statement is understood to be a coroutine and the IEnumerator return type need not be explicitly declared:
Also, a coroutine can be started in UnityScript by calling it as if it were a normal function:
Можно заметить, что счетчик цикла в функции Fade сохраняет правильное значение во время работы корутины. Фактически, любая переменная или параметр будут корректно сохранены между вызовами оператора yield.
By default, a coroutine is resumed on the frame after it yields but it is also possible to introduce a time delay using WaitForSeconds:
and in UnityScript:
This can be used as a way to spread an effect over a period time but it is also a useful optimization. Many tasks in a game need to be carried out periodically and the most obvious way to do this is to include them in the Update function. However, this function will typically be called many times per second. When a task doesn’t need to be repeated quite so frequently, you can put it in a coroutine to get an update regularly but not every single frame. An example of this might be an alarm that warns the player if an enemy is nearby. The code might look something like this:
If there are a lot of enemies then calling this function every frame might introduce a significant overhead. However, you could use a coroutine to call it every tenth of a second:
Это значительно уменьшит число проверок, но не окажет заметного влияния на игровой процесс.
Coroutines
When you call a function, it runs to completion before returning. This effectively means that any action taking place in a function must happen within a single frame update; a function call can’t be used to contain a procedural animation or a sequence of events over time. As an example, consider the task of gradually reducing an object’s alpha (opacity) value until it becomes completely invisible.
As it stands, the Fade function will not have the effect you might expect. In order for the fading to be visible, the alpha must be reduced over a sequence of frames to show the intermediate values being rendered. However, the function will execute in its entirety within a single frame update. The intermediate values will never be seen and the object will disappear instantly.
It is possible to handle situations like this by adding code to the Update function that executes the fade on a frame-by-frame basis. However, it is often more convenient to use a coroutine for this kind of task.
A coroutine is like a function that has the ability to pause execution and return control to Unity but then to continue where it left off on the following frame. In C#, a coroutine is declared like this:
It is essentially a function declared with a return type of IEnumerator and with the yield return statement included somewhere in the body. The yield return null line is the point at which execution will pause and be resumed the following frame. To set a coroutine running, you need to use the StartCoroutine function:
You will notice that the loop counter in the Fade function maintains its correct value over the lifetime of the coroutine. In fact any variable or parameter will be correctly preserved between yields.
By default, a coroutine is resumed on the frame after it yields but it is also possible to introduce a time delay using WaitForSeconds:
This can be used as a way to spread an effect over a period of time, but it is also a useful optimization. Many tasks in a game need to be carried out periodically and the most obvious way to do this is to include them in the Update function. However, this function will typically be called many times per second. When a task doesn’t need to be repeated quite so frequently, you can put it in a coroutine to get an update regularly but not every single frame. An example of this might be an alarm that warns the player if an enemy is nearby. The code might look something like this:
If there are a lot of enemies then calling this function every frame might introduce a significant overhead. However, you could use a coroutine to call it every tenth of a second:
This would greatly reduce the number of checks carried out without any noticeable effect on gameplay.
Note: You can stop a Coroutine with StopCoroutine and StopAllCoroutines. A coroutines also stops when the GameObject The fundamental object in Unity scenes, which can represent characters, props, scenery, cameras, waypoints, and more. A GameObject’s functionality is defined by the Components attached to it. More info
See in Glossary 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.