From dbfb94dbc6d9af107dbcff1c80648c9a8963b403 Mon Sep 17 00:00:00 2001 From: Koji Hasegawa Date: Mon, 11 Nov 2024 09:14:50 +0900 Subject: [PATCH] Fix wording about error handling in UGUIPlaybackAgent --- README.md | 10 ++++++---- README_ja.md | 10 ++++++---- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5e1adb7..207cebb 100644 --- a/README.md +++ b/README.md @@ -263,9 +263,6 @@ See **Anjin Annotations** below for more information. This is an Agent that playback uGUI operations with the Recorded Playback feature of the [Automated QA](https://docs.unity3d.com/Packages/com.unity.automated-testing@latest) package. -> [!NOTE] -> The Automated QA package is in the preview stage. Please note that destructive changes may occur, and the package itself may be discontinued or withdrawn. - The following can be set in an instance (.asset file) of this Agent.
@@ -284,7 +281,12 @@ The `Application.persistentDataPath` for each platform can be found in the Unity [Scripting API: Application.persistentDataPath](https://docs.unity3d.com/ScriptReference/Application-persistentDataPath.html). > [!WARNING] -> If you want to terminate the autopilot when detecting playback failures (e.g., the target Button is not found), enable `Error` in the [ErrorHandlerAgent](#ErrorHandlerAgent) setting. +> The Automated QA package outputs `LogType.Error` to the console when playback fails (e.g., the target Button cannot be found). The following setting is required to detect this and terminate the autopilot. +> 1. Add [ErrorHandlerAgent](#ErrorHandlerAgent) and set `Handle Error` to `Terminate Autopilot`. +> 2. Add [ConsoleLogger](#ConsoleLogger) and set `Filter LogType` to `Error` or higher. + +> [!NOTE] +> The Automated QA package is in the preview stage. Please note that destructive changes may occur, and the package itself may be discontinued or withdrawn. ### DoNothingAgent diff --git a/README_ja.md b/README_ja.md index fade2d3..2e4e8c1 100644 --- a/README_ja.md +++ b/README_ja.md @@ -266,9 +266,6 @@ uGUIのコンポーネントをランダムに操作するAgentです。 [Automated QA](https://docs.unity3d.com/Packages/com.unity.automated-testing@latest)パッケージのRecorded Playback機能でレコーディングしたuGUI操作を再生するAgentです。 -> [!NOTE] -> Automated QAパッケージはプレビュー段階のため、破壊的変更や、パッケージ自体の開発中止・廃止もありえる点、ご注意ください。 - このAgentのインスタンス（.assetファイル）には以下を設定できます。
@@ -289,7 +286,12 @@ Automated QAによる操作のレコーディングは、Unityエディターの を参照してください。 > [!WARNING] -> 再生の失敗（対象のボタンが見つからないなど）を検知してオートパイロットを停止するには、[ErrorHandlerAgent](#ErrorHandlerAgent) の設定で `Error` を有効にしてください。 +> Automated QAパッケージは、再生に失敗（対象のボタンが見つからないなど）したときコンソールに `LogType.Error` を出力します。これを検知してオートパイロットを停止するには、次の設定が必要です。 +> 1. [ErrorHandlerAgent](#ErrorHandlerAgent) を追加し、`Handle Error` を `Terminate Autopilot` に設定します +> 2. [ConsoleLogger](#ConsoleLogger) を追加し、`Filter LogType` に `Error` 以上を設定します + +> [!NOTE] +> Automated QAパッケージはプレビュー段階のため、破壊的変更や、パッケージ自体の開発中止・廃止もありえる点、ご注意ください。 ### DoNothingAgent