From 661aa1c600f72e40638887ff9e11ff905ed8107d Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Tue, 12 Aug 2025 11:34:37 +0300 Subject: [PATCH 1/3] Update code snippets to use FSentryVariant --- docs/platforms/unreal/enriching-events/breadcrumbs/index.mdx | 2 +- docs/platforms/unreal/enriching-events/context/index.mdx | 2 +- .../enriching-events/breadcrumbs/breadcrumbs-example/unreal.mdx | 2 +- platform-includes/enriching-events/set-context/unreal.mdx | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/platforms/unreal/enriching-events/breadcrumbs/index.mdx b/docs/platforms/unreal/enriching-events/breadcrumbs/index.mdx index fd3c04bbb90b36..27dc79ac58f9e1 100644 --- a/docs/platforms/unreal/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/unreal/enriching-events/breadcrumbs/index.mdx @@ -22,7 +22,7 @@ Manually record a breadcrumb: ```cpp USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem(); -TMap AdditionalData; +TMap AdditionalData; AdditionalData.Add("SomeKey", "SomeValue"); SentrySubsystem->AddBreadcrumb("Message", "Category", "Type", AdditionalData, ESentryLevel::Info); diff --git a/docs/platforms/unreal/enriching-events/context/index.mdx b/docs/platforms/unreal/enriching-events/context/index.mdx index 98cb2088f5db63..abcb7144d057ae 100644 --- a/docs/platforms/unreal/enriching-events/context/index.mdx +++ b/docs/platforms/unreal/enriching-events/context/index.mdx @@ -22,7 +22,7 @@ Then, use and give the context a uniqu ```cpp USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem(); -TMap ContextData; +TMap ContextData; AdditionalData.Add("Class", "Paladin"); AdditionalData.Add("Role", "Taunt"); diff --git a/platform-includes/enriching-events/breadcrumbs/breadcrumbs-example/unreal.mdx b/platform-includes/enriching-events/breadcrumbs/breadcrumbs-example/unreal.mdx index ab1111b77c50bd..00f44cbcb45d16 100644 --- a/platform-includes/enriching-events/breadcrumbs/breadcrumbs-example/unreal.mdx +++ b/platform-includes/enriching-events/breadcrumbs/breadcrumbs-example/unreal.mdx @@ -1,7 +1,7 @@ ```cpp USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem(); -TMap AdditionalData; +TMap AdditionalData; AdditionalData.Add("SomeKey", "SomeValue"); SentrySubsystem->AddBreadcrumb("Message", "Category", "Type", AdditionalData, ESentryLevel::Info); diff --git a/platform-includes/enriching-events/set-context/unreal.mdx b/platform-includes/enriching-events/set-context/unreal.mdx index cbe9a48b063a1e..360c519a180752 100644 --- a/platform-includes/enriching-events/set-context/unreal.mdx +++ b/platform-includes/enriching-events/set-context/unreal.mdx @@ -1,7 +1,7 @@ ```cpp USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem(); -TMap ContextData; +TMap ContextData; AdditionalData.Add("Class", "Paladin"); AdditionalData.Add("Role", "Taunt"); From 3b290e9e9f1c651d86967a72ad89887aa7ced057 Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Tue, 12 Aug 2025 11:43:50 +0300 Subject: [PATCH 2/3] Update scopes page --- .../platforms/unreal/enriching-events/scopes/index.mdx | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/platforms/unreal/enriching-events/scopes/index.mdx b/docs/platforms/unreal/enriching-events/scopes/index.mdx index 20b5bb2b9c4a9a..07e9a1112d8042 100644 --- a/docs/platforms/unreal/enriching-events/scopes/index.mdx +++ b/docs/platforms/unreal/enriching-events/scopes/index.mdx @@ -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 , 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 @@ -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. + + +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. + + + Any exceptions that occur within the callback function for configuring a local scope will not be From 0e121c6f5322f5309e31394689fb65ea58c739ee Mon Sep 17 00:00:00 2001 From: Ivan Tustanivskyi Date: Tue, 12 Aug 2025 11:47:57 +0300 Subject: [PATCH 3/3] Update screenshot page --- .../enriching-events/attach-screenshots/unreal.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/platform-includes/enriching-events/attach-screenshots/unreal.mdx b/platform-includes/enriching-events/attach-screenshots/unreal.mdx index f6b93b54a4b050..4d67065c11f9ef 100644 --- a/platform-includes/enriching-events/attach-screenshots/unreal.mdx +++ b/platform-includes/enriching-events/attach-screenshots/unreal.mdx @@ -11,7 +11,7 @@ Settings->AttachScreenshot = true; -Currently, this feature is supported for Windows and Linux only. +Currently, this feature is not supported on Android. @@ -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.