Skip to content

Commit

Permalink
Fix READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
nowsprinting committed Nov 24, 2024
1 parent 3912f0a commit 10235cf
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,15 +214,15 @@ In both cases, the key should be prefixed with `-` and specified as `-LIFESPAN_S

### 3. Run in Play Mode test

Autopilot works within your test code using the async method `Launcher.LaunchAutopilotAsync(string)`.
Autopilot works within your test code using the static method `Launcher.LaunchAutopilotAsync(string)`.
Specify the `AutopilotSettings` file path via the argument.

```
[Test]
public async Task LaunchAutopilotInTest()
{
// Load the first scene
await SceneManager.LoadSceneAsync(0);
// Load the first scene (required scene in "Scenes in Build")
await SceneManager.LoadSceneAsync("Title");
// Launch autopilot
await Launcher.LaunchAutopilotAsync("Assets/Path/To/AutopilotSettings.asset");
Expand All @@ -234,10 +234,14 @@ public async Task LaunchAutopilotInTest()
> [!WARNING]
> When running tests on a player, any necessary configuration files must be placed in the `Resources` folder to be included in the player build. It can use `IPrebuildSetup` and `IPostBuildCleanup` to insert processing into the test player build.
> The file path is specified relative to the `Resources` folder without the extension (".asset").
> [!NOTE]
> The test will fail if the test-runner detects a `LogException` or `LogError` output. You can suppress this by using `LogAssert.ignoreFailingMessages` assuming that you will use Anjin for error handling.
> [!NOTE]
> If running multiple scenarios in succession, you can preserve the output files by specifying different paths in `AutopilotSettings.outputRootPath`.


## Built-in Agents
Expand Down
10 changes: 7 additions & 3 deletions README_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,15 +217,15 @@ $(UNITY) \

### 3. Play Modeテスト内で実行

非同期メソッド `Launcher.LaunchAutopilotAsync(string)` を使用することで、テストコード内でオートパイロットが動作します。
静的メソッド `Launcher.LaunchAutopilotAsync(string)` を使用することで、テストコード内でオートパイロットが動作します。
引数には `AutopilotSettings` ファイルパスを指定します。

```
[Test]
public async Task LaunchAutopilotInTest()
{
// 最初のSceneをロード
await SceneManager.LoadSceneAsync(0);
// 最初のSceneをロード("Scenes in Build" に含まれている必要があります)
await SceneManager.LoadSceneAsync("Title");
// オートパイロットを起動
await Launcher.LaunchAutopilotAsync("Assets/Path/To/AutopilotSettings.asset");
Expand All @@ -237,10 +237,14 @@ public async Task LaunchAutopilotInTest()
> [!WARNING]
> テストをプレイヤーで実行するときは、必要な設定ファイルを `Resources` フォルダに置き、ビルドに含まれるようにしてください。テストのプレイヤービルドに処理を挟むには `IPrebuildSetup` および `IPostBuildCleanup` が利用できます。
> ファイルパスは `Resources` フォルダからの相対パスを拡張子(".asset")なしで指定します。
> [!NOTE]
> テストランナーに `LogException` または `LogError` 出力を検知されると、そのテストは失敗と判定されます。エラーハンドリングをAnjinで行なう前提で `LogAssert.ignoreFailingMessages` で抑止してもいいでしょう。
> [!NOTE]
> 複数のシナリオを連続実行する場合、`AutopilotSettings.outputRootPath` に個別のパスを指定することで出力ファイルを保全できます。


## ビルトインAgent
Expand Down

0 comments on commit 10235cf

Please sign in to comment.