与 Unity 编辑器集成

先决条件

关联项目

1. 在 Unity 编辑器中，选择 Edit（编辑）> Project Settings（项目设置）> Services（服务）。
2. 关联您的项目。
   • 如果项目没有 Unity Project ID：
     1. 选择 Create a Unity Project ID（创建 Unity Project ID）> Organizations（组织），然后从下拉菜单中选择一个组织。
     2. 选择 Create project ID（创建 Project ID）。
   • 如果已有 Unity Project ID：
     1. 选择 Use an existing Unity project ID（使用现有 Unity Project ID）。
     2. 从下拉菜单中选择组织和项目。
     3. 选择 Link project ID（关联 Project ID）。

UnityEditor.CloudProjectSettings.projectId

安装所需的包

• Deployment
• Cloud Code（2.1.1 或更高版本）

1. 在 Unity 编辑器的 Package Manager（包管理器）窗口中，选择 +（添加）> Add package by name...（按名称添加包...）。
2. 输入

   com.unity.services.deployment

   。
3. 选择 Add（添加）。
4. 对

   com.unity.services.cloudcode

   重复以上步骤。

在 Unity 编辑器中创作

创建脚本

1. 在 Unity 编辑器的 Project（项目）窗口中右键单击，然后选择 Create（创建）> Services（服务）> Cloud Code Js Script（Cloud Code Js 脚本）。
2. 像命名 C# 脚本一样命名该脚本。上传到服务时，Cloud Code 脚本会使用其文件名作为标识符。
3. 按 Enter（输入）。

编辑脚本

• 在 Project（项目）选项卡中，双击现有脚本。
• 在 Deployment（部署）窗口中，找到现有脚本，然后从右键单击菜单中选择 Open（打开）。

1. 在 Unity 编辑器中，选择 Edit（编辑）> Preferences...（偏好设置...）> Cloud Code。
2. 在 Javascript Editor（Javascript 编辑器）部分中，选择所需的 JS 编辑器的应用程序路径。
3. 选择 Apply（应用）。

• $(File)

  ：资源的文件路径

• $(ProjectPath)

  ：项目目录

• $(SolutionPath)

  ：解决方案路径

• $(EditorExePath)

  ：编辑器可执行文件路径（在 Unity 编辑器中选择 Edit（编辑）> Preferences...（偏好设置...）> External Tools（外部工具））

• JetBrains Rider（在 Windows 上）：
  • 应用程序：

    cmd.exe

  • 参数：

    /C "$(EditorExePath) $(ProjectPath) $(File)"

• Microsoft Visual Studio Code：
  • 应用程序：

    Code.exe

  • 参数：

    $(ProjectPath) $(File)"

部署脚本

修改脚本参数

在编辑器的 Inspector（检视面板）窗口中访问参数

• String（字符串）
• Boolean（布尔值）
• Numeric（数值）
• JSON
• Any（任意）

在脚本正文中声明参数

params

module.exports

module.exports.params = { "echo" : "Boolean" }

type

required

module.exports = async ({ params, context, logger }) => {    return {        "value": params["aParam"]    };};module.exports.params = { "aParam" : { "type": "String", "required": true } }

module.exports = async ({ params, context, logger }) => {    var value = params["echo"] ? params["aParam"] : "default";    return {        "value": value    };};module.exports.params = {  "echo" : "Boolean",  "aParam" : { "type": "String", "required": true } }

JS 捆绑包

import

require

bundling

module.exports.bundling = true;

module.exports.helloWorld = "Hello world!";

const lib = require("./lib");module.exports = async ({ params, context, logger }) => {    return {        "value": lib.helloWorld    };};module.exports.bundling = true;

Deployment（部署）窗口

Unity 编辑器中的 Cloud Code JavaScript 项目

Assets

CloudCode

cloud_script.js

node_modules

package.json

package-lock.json

package.json

package.json

package-lock.json

NodeJS

自动补全

.d.ts

.d.ts

node_modules

package.json

node_modules

外部工具

npm install ...

ESLint

1. 运行

   npm i -D eslint

   。此命令会将 ESLint 添加到项目依赖项。
2. 在项目根目录下创建一个包含以下内容的

   .eslint.json

   文件： JSON

   {    "env": {    "commonjs": true,    "es2021": true    },    "extends": "eslint:recommended",    "parserOptions": {    "ecmaVersion": 13    },    "rules": {    }}

3. 配置集成开发环境以运行 ESLint。对于 Visual Studio Code，这是自动进行的，但可能还需要其他设置，具体取决于集成开发环境。
4. ESLint 现在应该已经配置完成并可以正常工作。

eslint:recommended

if (something == -0)

Jest

1. 运行

   npm install --save-dev jest

   。此命令将安装 Jest 包。
2. 配置 Jest 以使用

   .es10

   脚本运行。
3. 向

   package.json

   添加以下代码片段： JSON

   "jest": {    "moduleFileExtensions": ["es10", "js"],    "testMatch": ["**/*.test.es10"]}

moduleFileExtensions

js

es10

testMatch

.test.es10

单元测试示例

要测试的脚本：

module.exports = async ({ params, context, logger }) => {    return {value: "1"};};

测试脚本：

const test = require("./jest_01.es10")it("test",async () =>{    expect(await test({})).toMatchObject({value:"1"});});

运行您的测试

npm run test