Skip to content

Unreal Engine: Update plugin docs #14624

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

Merged
merged 3 commits into from
Aug 12, 2025
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Manually record a breadcrumb:
```cpp
USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem<USentrySubsystem>();

TMap<FString, FString> AdditionalData;
TMap<FString, FSentryVariant> AdditionalData;
AdditionalData.Add("SomeKey", "SomeValue");

SentrySubsystem->AddBreadcrumb("Message", "Category", "Type", AdditionalData, ESentryLevel::Info);
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/unreal/enriching-events/context/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Then, use <PlatformIdentifier name="set-context" /> and give the context a uniqu
```cpp
USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem<USentrySubsystem>();

TMap<FString, FString> ContextData;
TMap<FString, FSentryVariant> ContextData;
AdditionalData.Add("Class", "Paladin");
AdditionalData.Add("Role", "Taunt");

Expand Down
10 changes: 7 additions & 3 deletions docs/platforms/unreal/enriching-events/scopes/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,7 @@ To learn what useful information can be associated with scopes see

## Local Scopes

We also support pushing and configuring a scope within a single call. This is typically
called <PlatformIdentifier name="with-scope" />, <PlatformIdentifier name="push-scope" /> or implemented as a function parameter on the capture methods, depending on the SDK. It's very helpful if
you only want to send data for one specific event.
We also support pushing and configuring a scope within a single call. This is implemented as a delegate parameter on the capture methods. It's very helpful if you only want to send data for one specific event.

### Using Scope Callback Parameter

Expand Down Expand Up @@ -95,6 +93,12 @@ made will stay isolated within the callback function. This allows you to
more easily isolate pieces of context information to specific locations in your code or
even call `clear` to briefly remove all context information.

<Alert>

On Windows and Linux, the scope object that is passed to the callback is empty and doesn't contain any of the current scope data.

</Alert>

<Alert title="Important">

Any exceptions that occur within the callback function for configuring a local scope will not be
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Settings->AttachScreenshot = true;

<Alert>

Currently, this feature is supported for Windows and Linux only.
Currently, this feature is not supported on Android.

</Alert>

Expand All @@ -20,7 +20,7 @@ Currently, this feature is supported for Windows and Linux only.
Since the Unreal Engine SDK consists of multiple SDKs, the specific mechanism with which a screenshot is captured will vary depending on where the error originated.

- On Windows/Linux, errors from within your game will be captured using the Unreal Engine API. This means that screenshots will only contain what's visible within your game. Any overlays on top of your game won't be visible.
- On Apple/Android, screenshots will be captured using platform APIs. If you're using a native plugin to display an overlay and an error occurs, the SDK will try to capture a screenshot that contains the overlay.
- On Mac/iOS, screenshots will be captured using platform APIs. If you're using a native plugin to display an overlay and an error occurs, the SDK will try to capture a screenshot that contains the overlay.

<Alert>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
```cpp
USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem<USentrySubsystem>();

TMap<FString, FString> AdditionalData;
TMap<FString, FSentryVariant> AdditionalData;
AdditionalData.Add("SomeKey", "SomeValue");

SentrySubsystem->AddBreadcrumb("Message", "Category", "Type", AdditionalData, ESentryLevel::Info);
Expand Down
2 changes: 1 addition & 1 deletion platform-includes/enriching-events/set-context/unreal.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
```cpp
USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem<USentrySubsystem>();

TMap<FString, FString> ContextData;
TMap<FString, FSentryVariant> ContextData;
AdditionalData.Add("Class", "Paladin");
AdditionalData.Add("Role", "Taunt");

Expand Down