使用await关键字实现游戏脚本的协同例程

时间:2013-06-04 23:39:43

标签: c# xna async-await coroutine

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

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

这意味着等待60帧,向玩家射击,等待30,向玩家射击,等待30 ...... e.t.c。

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

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

调用者保持一堆活动例程(IEnumerable计数器上的0)和休眠例程(> 0)。每个帧调用者将每个睡眠例程的睡眠帧计数器减1,直到达到0.此例程再次生效并继续执行直到下一个收益返回。这种方法在大多数情况下都能正常工作,但是子程序不能像下面那样拆分,这很烦人。

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。是否可以在调用方法中嵌套等待,就像我想要收益率回报一样?我如何使用等待实现计数器?例程的调用者需要控制递减为每个等待例程留下的等待帧,因为它将是每帧调用一次的等待帧。我将如何实现这一目标?

1 个答案:

答案 0 :(得分:3)

我不确定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);
    }
}

现在我们可以进入实施部分。当然你可以实现一个自定义的等待对象,但我只依赖TaskTaskCompletionSource<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<>

更新简化代码