GDTask 项目下载及安装教程

1. 项目介绍

GDTask 是一个为 Godot 游戏引擎提供的异步/等待功能插件。它基于 Cysharp 的 UniTask 库，旨在简化 Godot 中的异步编程。通过 GDTask，开发者可以更轻松地处理异步任务，如延迟、信号等待和取消操作。

2. 项目下载位置

GDTask 项目托管在 GitHub 上，可以通过以下步骤进行下载：

1. 打开终端或命令提示符。

2. 使用 git clone 命令下载项目：

   git clone https://github.com/Fractural/GDTask.git
   

3. 项目安装环境配置

3.1 环境要求

• 操作系统：Windows、macOS、Linux
• Godot 版本：Godot 4.x
• 编程语言：C#

3.2 环境配置示例

以下是配置 Godot 和 C# 环境的步骤：

1. 安装 Godot 4.x：

   • 从 Godot 官方网站 下载并安装 Godot 4.x。

2. 安装 .NET SDK：

   • 从 .NET 官方网站 下载并安装 .NET SDK。

3. 配置 Godot 项目：

   • 打开 Godot 编辑器，创建一个新项目。
   • 在项目设置中，确保启用 C# 支持。

3.3 环境配置图片示例

4. 项目安装方式

4.1 手动下载安装

1. 下载 GDTask 项目到本地。
2. 将 addons/GDTask 文件夹复制到你的 Godot 项目中的 addons 目录下。

4.2 使用 Git Submodules 安装

1. 确保你的 Godot 项目已经初始化为 Git 仓库。

2. 在终端中运行以下命令：

   git submodule add -b release https://github.com/fractural/GDTask.git addons/GDTask
   

3. 将 addons/GDTask/Autoload/GDTaskPlayerLoopAutoload 添加为 Godot 项目的自动加载脚本。

5. 项目处理脚本

以下是一个简单的 GDTask 脚本示例，展示了如何使用 GDTask 处理异步任务：

using Godot;
using System;
using Fractural.Tasks;

public class Test : Node
{
    [Signal]
    public delegate void MySignalHandler(int number, bool boolean);

    public override void _Ready()
    {
        // 运行一个非异步方法中的任务
        Run().Forget();
    }

    public async GDTaskVoid Run()
    {
        // 等待一定数量的帧
        await GDTask.DelayFrame(100);

        // 等待一定时间
        await GDTask.Delay(TimeSpan.FromSeconds(10));

        // 等待信号
        var signalResults = await GDTask.ToSignal(this, nameof(MySignal));

        // 取消等待信号
        var cts = new CancellationTokenSource();
        try
        {
            var signalResults = await GDTask.ToSignal(this, nameof(MySignal), cts.Token);
        }
        catch (OperationCanceledException)
        {
            GD.Print("Awaiting MySignal cancelled");
        }

        // 返回一个值
        string result = await RunWithResult();
        GD.Print(result);
    }

    public async GDTask<string> RunWithResult()
    {
        await GDTask.Delay(TimeSpan.FromSeconds(3));
        return "A result string";
    }

    public async GDTaskVoid WaitAndEmitMySignal(TimeSpan delay)
    {
        await GDTask.Delay(delay);
        EmitSignal(nameof(MySignal), 10, true);
    }
}

通过以上步骤，你可以在 Godot 项目中成功下载、安装并使用 GDTask 插件。