Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REG-1888] Update documentation for usage of RGTestUtils #80

Merged
merged 1 commit into from
Aug 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/gameplay-sessions/gameplay-sessions-reference.mdx
Original file line number Diff line number Diff line change
@@ -237,6 +237,9 @@ Since UnityStats is an editor-only feature, some performance information, specif
The `RGTestUtils` class is a utility class that provides methods for loading and playing back recordings in Unity
Play Mode tests. This class is included in the SDK and can be used to automate the testing of your game.

To use this class, first add `RegressionGames` and `RegressionGames.TestFramework` as references to your test assembly:
![Test assembly references for Regression Games SDK](img/test_assembly_refs.png)

### API

```csharp
Binary file added docs/gameplay-sessions/img/test_assembly_refs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.