Unity脚本编程之——协程（Coroutine）

Posted 2020-11-02 果子鲤鱼

本文翻译自Unity官方文档：https://docs.unity3d.com/Manual/Coroutines.html

专有名词：

Coroutine 　　协程

Alpha 　　不透明度

当你调用一个函数时，它会在返回之前一直运行到结束。这实际上意味着在一个函数中发生的任何行为都必须在一个帧更新中发生；函数调用不能用于包含过程动画或事件序列。例如，考虑逐步减少对象的alpha（不透明度）值的任务，直到它也变得完全不可见。

void Fade() {
    for (float f = 1f; f >= 0; f -= 0.1f) {
        Color c = renderer.material.color;
        c.a = f;
        renderer.material.color = c;
    }
}

正如你所看到的实际情况那样，Fade()函数不会有你所期望的效果。为了让渐变变得可见，必须通过一系列帧更新来减少alpha值，以显示正在渲染的中间值。但是，该函数将在单个更新中全部执行了，中间值将永远不会被看到，对象将立即消失。

可以通过向Update()函数添加代码来处理类似的情况，该函数基于逐帧执行渐变。然而，使用Coroutine来完成这类任务通常更加方便。

Coroutine就像这样一个函数，它具有暂停执行和将控制权返回Unity的功能，但在接下来的帧中继续执行。在C#中，Coroutine是这样声明的：

IEnumerator Fade() {
    for (float f = 1f; f >= 0; f -= 0.1f) {
        Color c = renderer.material.color;
        c.a = f;
        renderer.material.color = c;
        yield return null;
    }
}

它本质是一个函数，它使用返回类型为IEnumerator声明，并且包含在主体的某个地方的yield return语句。yield return那一行是执行暂停的点，并将返回到接下来的帧中。你需要通过StarCoroutine设置协程的运行。

void Update() {
    if (Input.GetKeyDown("f")) {
        StartCoroutine("Fade");
    }
}

在UnityScript中，事情稍微简单一些。任何包含yield语句的函数都被理解为协程（Coroutine），而IEumerator返回类型不需要显式声明。

function Fade() {
    for (var f = 1.0; f >= 0; f -= 0.1) {
        var c = renderer.material.color;
        c.a = f;
        renderer.material.color = c;
        yield;
    }
}

同样，可以在UnityScript中启动协程（Coroutine），只需当成一个普通的正常函数调用就可以了。

function Update() {
    if (Input.GetKeyDown("f")) {
        Fade();
    }
}

你会注意到，在Fade()函数中，循环计数器在协程（Coroutine）的声明周期中保持其正确的值。事实上，任何变量或参数都将在yield之间得到正确的保留。

默认情况下，在yield之后，在这一帧中会恢复一个协程（Coroutine），但是也可以使用WaitForSeconds来引入时间延迟。在UnityScript中是这样的：

function Fade() {
    for (var f = 1.0; f >= 0; f -= 0.1) {
        var c = renderer.material.color;
        c.a = f;
        renderer.material.color = c;
        yield WaitForSeconds(0.1);
    }
}

这可以作为一种实现一段时间内的类似传播效果的方式，但同时也是一种有用的优化。游戏中的许多任务需要定期进行，最明显的方法是将它们包含在Update函数中。但是，这个函数通常每秒会被调用多次。当一项任务不需要频繁地重复时，你可以把它放入一个协程（Coroutine），以定期更新，但不是每一帧都更新。一个例子可能是警告玩家是否敌人在附近。一般的UnityScript代码看起来像这样子：

function ProximityCheck() {
    for (int i = 0; i < enemies.Length; i++) {
        if (Vector3.Distance(transform.position, enemies[i].transform.position) < dangerDistance) {
                return true;
        }
    }
    
    return false;
}

如果有很多敌人，然后调用这个函数，每一帧都会引入一个显著的开销。但是，你可以用协程（Coroutine）每隔十分之一秒来调用它：

IEnumerator DoCheck() {
    for(;;) {
        ProximityCheck;
        yield return new WaitForSeconds(.1f);
    }
}

这将大大减少检查的次数，而不会对游戏性产生任何明显的影响。

注意：当一个MonoBehaviour被禁用（disable）时，协程（Coroutine）并没有停止，但是只有当它被完全摧毁（destroyed）时才会停止。你可以使用MonoBehaviour.StopCoroutine和MonoBehaviour.StopAllCoroutines来停止协程（Coroutine）的执行。当Monobehaviour被摧毁时（destroyed），协程也会停止。