Unity エディターとのインテグレーション

前提条件

プロジェクトのリンク

1. Unity エディターで、Edit (編集) > Project Settings (プロジェクト設定) > Services (サービス) の順に選択します。
2. プロジェクトをリンクします。
   • プロジェクトに Unity プロジェクト ID がない場合:
     1. Create a Unity Project ID (Unity プロジェクト ID の作成) > Organizations (組織) の順に選択し、ドロップダウンメニューから組織を選択します。
     2. Create project ID (プロジェクト ID を作成) を選択します。
   • 既存の Unity プロジェクト ID がある場合:
     1. Use an existing Unity project ID (既存の Unity プロジェクト ID を使用) を選択します。
     2. ドロップダウンメニューから組織とプロジェクトを選択します。
     3. Link project ID (プロジェクト ID をリンク) を選択します。

UnityEditor.CloudProjectSettings.projectId

必要なパッケージをインストールする

• Deployment
• Cloud Code (2.1.1 以降)

1. Unity エディターの Package Manager (パッケージマネージャー) ウィンドウで、+ (add) (+ (追加)) > 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 を実行するように IDE を設定します。これは、Visual Studio Code では自動的に行われますが、IDE によっては追加の設定が必要になることがあります。
4. ESLint が設定され、動作しています。

eslint:recommended

if (something == -0)

Jest

1. npm install --save-dev jest

   を実行します。このコマンドにより、Jest パッケージがインストールされます。

2. .es10

   スクリプトで実行するように Jest を設定します。
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