TypeScript for Unity 项目教程

1. 项目目录结构及介绍

typescript-for-unity/
├── Assets/
│   ├── Plugins/
│   └── Scripts/
├── Packages/
├── ProjectSettings/
├── src/
│   ├── JSCubeBehaviour.ts
│   └── vendor/
├── .gitignore
├── .gitmodules
├── .prettierrc
├── LICENSE
├── README.md
├── tsconfig.json

目录结构介绍

• Assets/: 包含项目的资源文件，如插件和脚本。
  • Plugins/: 存放第三方插件。
  • Scripts/: 存放Unity脚本。
• Packages/: 存放Unity的包文件。
• ProjectSettings/: 存放Unity项目的设置文件。
• src/: 存放TypeScript源代码。
  • JSCubeBehaviour.ts: 示例TypeScript脚本。
  • vendor/: 存放第三方库。
• .gitignore: Git忽略文件配置。
• .gitmodules: Git子模块配置。
• .prettierrc: Prettier代码格式化配置。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript配置文件。

2. 项目启动文件介绍

启动文件

• src/JSCubeBehaviour.ts: 这是一个示例TypeScript脚本，展示了如何在Unity中使用TypeScript编写脚本。该文件包含一个简单的行为脚本，控制一个立方体移动。

启动步骤

1. 克隆项目到本地：

   git clone [e-mail]:SpiralP/typescript-for-unity.git
   

2. 进入项目目录并初始化子模块：

   cd typescript-for-unity
   git submodule init
   git submodule update
   

3. 打开Unity项目，加载场景 "Default Scene"，即可看到立方体移动的效果。

3. 项目的配置文件介绍

tsconfig.json

{
  "compilerOptions": {
    "target": "es2018",
    "module": "esnext",
    "moduleResolution": "node",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"]
}

配置文件介绍

• compilerOptions: 编译器选项，定义了TypeScript编译器的配置。
  • target: 指定ECMAScript目标版本为ES2018。
  • module: 指定模块系统为ESNext。
  • moduleResolution: 模块解析策略为Node.js。
  • strict: 启用所有严格类型检查选项。
  • esModuleInterop: 允许从CommonJS模块导入ES模块。
  • skipLibCheck: 跳过库文件的类型检查。
  • forceConsistentCasingInFileNames: 强制文件名大小写一致。
• include: 指定包含的文件或目录，这里包含src目录下的所有文件。

通过以上配置，项目可以顺利编译和运行TypeScript代码，并在Unity中实现脚本功能。