Skip to content

Commit

Permalink
Fix wording about error handling in UGUIPlaybackAgent
Browse files Browse the repository at this point in the history
  • Loading branch information
nowsprinting committed Nov 11, 2024
1 parent 856652f commit dbfb94d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<dl>
Expand All @@ -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
Expand Down
10 changes: 6 additions & 4 deletions README_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -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ファイル)には以下を設定できます。

<dl>
Expand All @@ -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
Expand Down

0 comments on commit dbfb94d

Please sign in to comment.