c# - 使用 await 关键字实现游戏脚本的协程

Question

我正尝试在 C# 中实现协同例程，以便在我的游戏中编写敌人行为脚本时让我的生活更轻松。游戏是固定帧率的。编写脚本的理想语法是:

wait(60)
while(true)
{
  shootAtPlayer();
  wait(30);
}

这意味着等待 60 帧，向玩家射击，等待 30 帧，向玩家射击，等待 30 帧......等等

我在 C# 中使用 yield return 实现了这个解决方案:

public IEnumerable update()
{
  yield return 60;
  while(true)
  {
    shootAtPlayer();
    yield return 30;
  }
}

调用者保留了一堆事件例程(IEnumerable 计数器上为 0)和休眠例程(> 0)。每帧调用者都会将每个休眠例程的休眠帧计数器减 1，直到一个达到 0。该例程再次激活并继续执行直到下一个 yield 返回。这在大多数情况下工作正常，但令人讨厌的是子例程不能像下面这样拆分:

public IEnumerable update()
{
  yield return 60;
  while(true)
  {
    doSomeLogic()
    yield return 30;
  }
}

public IEnumerable doSomeLogic()
{
  somethingHappening();
  yield return 100;
  somethingElseHappens();
}

上面的语法是不正确的，因为 yield return 不能嵌套在另一个方法中，这意味着执行状态只能在一个方法中维护(在这种情况下是 update() )。这是 yield return 语句的一个限制，我真的找不到解决它的方法。

我之前问过如何使用 C# 实现所需的行为，有人提到 await 关键字在这种情况下可能效果很好。我现在想弄清楚如何更改代码以使用 await。是否可以像我想用 yield return 那样在调用的方法中嵌套等待？另外我将如何使用等待来实现计数器？例程的调用者需要控制递减为每个等待例程留下的等待帧，因为它将每帧调用一次。我将如何实现它？

Answer 1

我不确定 async/await 是否适用于此，但绝对有可能。我已经创建了一个小型(好吧，至少我试图让它尽可能小)测试环境来说明可能的方法。让我们从一个概念开始:

/// <summary>A simple frame-based game engine.</summary>
interface IGameEngine
{
    /// <summary>Proceed to next frame.</summary>
    void NextFrame();

    /// <summary>Await this to schedule action.</summary>
    /// <param name="framesToWait">Number of frames to wait.</param>
    /// <returns>Awaitable task.</returns>
    Task Wait(int framesToWait);
}

这应该允许我们以这种方式编写复杂的游戏脚本:

static class Scripts
{
    public static async void AttackPlayer(IGameEngine g)
    {
        await g.Wait(60);
        while(true)
        {
            await DoSomeLogic(g);
            await g.Wait(30);
        }
    }

    private static async Task DoSomeLogic(IGameEngine g)
    {
        SomethingHappening();
        await g.Wait(10);
        SomethingElseHappens();
    }

    private static void ShootAtPlayer()
    {
        Console.WriteLine("Pew Pew!");
    }

    private static void SomethingHappening()
    {
        Console.WriteLine("Something happening!");
    }

    private static void SomethingElseHappens()
    {
        Console.WriteLine("SomethingElseHappens!");
    }
}

我将以这种方式使用引擎:

static void Main(string[] args)
{
    IGameEngine engine = new GameEngine();
    Scripts.AttackPlayer(engine);
    while(true)
    {
        engine.NextFrame();
        Thread.Sleep(100);
    }
}

现在我们可以进入实现部分了。当然你可以实现一个自定义的可等待对象，但我只依赖 Task和 TaskCompletionSource<T> (不幸的是，没有非通用版本，所以我只使用 TaskCompletionSource<object> ):

class GameEngine : IGameEngine
{
    private int _frameCounter;
    private Dictionary<int, TaskCompletionSource<object>> _scheduledActions;

    public GameEngine()
    {
        _scheduledActions = new Dictionary<int, TaskCompletionSource<object>>();
    }

    public void NextFrame()
    {
        if(_frameCounter == int.MaxValue)
        {
            _frameCounter = 0;
        }
        else
        {
            ++_frameCounter;
        }
        TaskCompletionSource<object> completionSource;
        if(_scheduledActions.TryGetValue(_frameCounter, out completionSource))
        {
            Console.WriteLine("{0}: Current frame: {1}",
                Thread.CurrentThread.ManagedThreadId, _frameCounter);
            _scheduledActions.Remove(_frameCounter);
            completionSource.SetResult(null);
        }
        else
        {
            Console.WriteLine("{0}: Current frame: {1}, no events.",
                Thread.CurrentThread.ManagedThreadId, _frameCounter);
        }
    }

    public Task Wait(int framesToWait)
    {
        if(framesToWait < 0)
        {
            throw new ArgumentOutOfRangeException("framesToWait", "Should be non-negative.");
        }
        if(framesToWait == 0)
        {
            return Task.FromResult<object>(null);
        }
        long scheduledFrame = (long)_frameCounter + (long)framesToWait;
        if(scheduledFrame > int.MaxValue)
        {
            scheduledFrame -= int.MaxValue;
        }
        TaskCompletionSource<object> completionSource;
        if(!_scheduledActions.TryGetValue((int)scheduledFrame, out completionSource))
        {
            completionSource = new TaskCompletionSource<object>();
            _scheduledActions.Add((int)scheduledFrame, completionSource);
        }
        return completionSource.Task;
    }
}

主要思想:

• Wait方法创建一个任务，该任务在达到指定帧时完成。
• 我保留了一个预定任务字典，并在达到要求的帧时立即完成它们。

更新:通过删除不必要的 List<> 简化了代码.