TypeScript for Unity 使用教程

1. 项目介绍

TypeScript for Unity 是一个开源项目，允许开发者在 Unity 中使用现代 ES2018 JavaScript 和 TypeScript 进行脚本编写或作为嵌入式语言。该项目是从一个未发布的游戏中提取出来的，支持 Windows、Mac 和 Linux 平台。

主要特性

• 使用 TypeScript 或 JavaScript 进行游戏脚本编写。
• 支持 ES2018 特性，无需编译步骤。
• 原生 ECMAScript 模块支持（import/export）。
• 简单的 JSBehaviour 对象，允许在 JS/TS 中编写 MonoBehaviours。
• 生成的 TypeScript 绑定，用于 Unity 类。

2. 项目快速启动

2.1 克隆项目

首先，克隆项目到本地：

git clone https://github.com/SpiralP/typescript-for-unity.git
cd typescript-for-unity

2.2 初始化子模块

初始化并更新子模块：

git submodule init
git submodule update

2.3 打开 Unity 项目

打开 Unity 编辑器，加载项目。打开场景 "Default Scene"，你应该会看到一个立方体从摄像机移动。

2.4 运行示例代码

示例代码位于 src/JSCubeBehaviour.ts。你可以通过以下方式运行代码：

import JSCubeBehaviour from "JSCubeBehaviour";

const cube = new JSCubeBehaviour();
cube.Start();
cube.Update();

3. 应用案例和最佳实践

3.1 使用 TypeScript 编写 MonoBehaviours

在 Unity 中，MonoBehaviours 是常用的脚本组件。通过 TypeScript for Unity，你可以使用 TypeScript 编写 MonoBehaviours：

import { JSBehaviour } from "UnityEngine";

export default class MyBehaviour extends JSBehaviour {
    Start() {
        console.log("MyBehaviour started!");
    }

    Update() {
        console.log("Updating MyBehaviour...");
    }
}

3.2 使用 ECMAScript 模块

项目支持原生 ECMAScript 模块，你可以轻松地导入和导出模块：

// math.ts
export function add(a: number, b: number): number {
    return a + b;
}

// main.ts
import { add } from "./math";

console.log(add(1, 2)); // 输出: 3

4. 典型生态项目

4.1 PuerTS

PuerTS 是另一个在 Unity 中使用 TypeScript 的解决方案，由腾讯开源。它提供了更高级的功能，如静态类型检查和高效的反射调用。

• GitHub 地址: Tencent/puerts

4.2 Preact with Unity

Preact 是一个轻量级的 React 替代品，可以在 Unity 中用于构建 UI。通过 TypeScript for Unity，你可以结合 Preact 实现高效的 UI 开发。

• Reddit 讨论: Use Typescript and JSX with Unity

通过这些生态项目，你可以进一步扩展 TypeScript for Unity 的功能，提升开发效率和代码质量。