Skip to content

Commit f3dd175

Browse files
authored
feat(Unity): Editor Facelift (#13514)
1 parent 253d903 commit f3dd175

File tree

16 files changed

+28
-27
lines changed

16 files changed

+28
-27
lines changed
Binary file not shown.
119 KB
Loading

docs/platforms/unity/configuration/app-not-responding/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ On platforms that do no support multithreading the ANR detection falls back to r
1717

1818
ANR detection is enabled by default in Sentry, but you can opt-out through the editor window by going to `Tools -> Sentry -> Advanced -> ANR Detection`. You can also set the ANR timeout there.
1919

20-
![ANR Detection](./img/unity-anr.jpg)
20+
![ANR Detection](./img/unity-anr.png)
2121

2222
You can also opt out by disabling the integration.
2323

13.8 KB
Loading
14 KB
Loading
131 KB
Loading

docs/platforms/unity/enriching-events/screenshots/index.mdx

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,28 @@ This feature is only available for SDKs with a user interface, like the ones for
99

1010
## Enabling Screenshots
1111

12-
Because screenshots may contain <PlatformLink to="/data-management/sensitive-data/">PII</PlatformLink>, they are an opt-in feature. You can enable screenshots as shown below:
12+
Because screenshots may contain <PlatformLink to="/data-management/sensitive-data/">PII</PlatformLink>, they are an opt-in feature. You can enable screenshots as shown below through **Tools > Sentry**:
1313

14-
<PlatformContent includePath="enriching-events/attach-screenshots" />
14+
![Options Screenshot Configuration](./img/editor-window.png)
15+
16+
Or, like so, if you're [configuring things programatically](/platforms/unity/configuration/options/):
17+
18+
```csharp {tabTitle:ScriptableOptionsConfiguration}
19+
options.AttachScreenshot = true;
20+
```
21+
22+
## Screenshot capture mechanism
23+
24+
Since the Unity SDK internally consists of multiple SDKs, the mechanism with which a screenshot gets captured depends on where the error originates.
25+
26+
- C# errors from within your game will be captured through Unity's built-in [ScreenCapture](https://docs.unity3d.com/ScriptReference/ScreenCapture.html). This means that screenshots only contain things visible within your game. Overlays on top of your game will not be visible.
27+
- Native errors get captured by their respective SDK. If you're using a native plugin to display an overlay and an error occurs then that SDK will try to capture a screenshot that contains the overlay.
28+
29+
<Alert>
30+
31+
Screenshots might contain PII of your app. For example, if your game has a registration form and an error happens while the form is being displayed.
32+
33+
</Alert>
1534

1635
## Viewing Screenshots
1736

131 KB
Loading

docs/platforms/unity/enriching-events/view-hierarchy/index.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,13 @@ This feature only applies to SDKs with a user interface, such as the ones for mo
99

1010
## Enabling View Hierarchy Attachments
1111

12-
View hierarchy debugging is an opt-in feature. You can enable it via the configuration editor `Enrichment -> Attach Hierarchy` or programmatically:
12+
View hierarchy debugging is an opt-in feature. You can enable attaching the view hierarchy as shown below through **Tools > Sentry**:
1313

14-
```csharp
14+
![Options Screenshot Configuration](./img/editor-window.png)
15+
16+
Or, like so, if you're [configuring things programatically](/platforms/unity/configuration/options/):
17+
18+
```csharp {tabTitle:ScriptableOptionsConfiguration}
1519
options.AttachViewHierarchy = true;
1620
```
1721

15.8 KB
Loading

0 commit comments

Comments
 (0)