Unreal Engine plugin docs update #13288
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Bundle ReportChanges will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
|
bitsandfoxes
approved these changes
May 5, 2025
|
|
||
| <ConfigKey name="attach-game-log"> | ||
|
|
||
| When enabled, game log file is automatically attached to all events captured if the current build configuration allows logging. |
Contributor
There was a problem hiding this comment.
Suggested change
| When enabled, game log file is automatically attached to all events captured if the current build configuration allows logging. | |
| When enabled, and when the current build configuration supports logging, the game's log file is automatically attached to all events. |
|
|
||
| <ConfigKey name="attach-gpu-dump"> | ||
|
|
||
| When enabled, [Nsight Aftermath](https://developer.nvidia.com/nsight-aftermath) mini-dump file is automatically attached to GPU crash events captured. |
Contributor
There was a problem hiding this comment.
Suggested change
| When enabled, [Nsight Aftermath](https://developer.nvidia.com/nsight-aftermath) mini-dump file is automatically attached to GPU crash events captured. | |
| When enabled, a [Nsight Aftermath](https://developer.nvidia.com/nsight-aftermath) minidump file is automatically attached to captured GPU crash events. |
|
|
||
| <Alert> | ||
|
|
||
| This feature is currently supported only for Nvidia GPUs. |
Contributor
There was a problem hiding this comment.
Suggested change
| This feature is currently supported only for Nvidia GPUs. | |
| This feature is currently limited to Nvidia GPUs. |
|
|
||
| These options can be used to hook the SDK in various ways to customize the reporting of events. | ||
|
|
||
| The callbacks you set as hooks will be called on the thread where the event happened. If the event occurs on a non-game thread during garbage collection the callback will not be invoked. |
Contributor
There was a problem hiding this comment.
Suggested change
| The callbacks you set as hooks will be called on the thread where the event happened. If the event occurs on a non-game thread during garbage collection the callback will not be invoked. | |
| The hooks you set as callbacks will be called and executed on the same thread where the event happened. Note that if the event occurs on a non-game thread during garbage collection then then callback will not be invoked. |
Comment on lines
+54
to
+55
| virtual USentryBreadcrumb* HandleBeforeBreadcrumb_Implementation(USentryBreadcrumb* Breadcrumb, USentryHint* Hint) | ||
| { |
Contributor
There was a problem hiding this comment.
Suggested change
| virtual USentryBreadcrumb* HandleBeforeBreadcrumb_Implementation(USentryBreadcrumb* Breadcrumb, USentryHint* Hint) | |
| { | |
| virtual USentryBreadcrumb* HandleBeforeBreadcrumb_Implementation(USentryBreadcrumb* Breadcrumb, USentryHint* Hint) | |
| { |
They should have the same indentation, right?
|
|
||
| <Alert> | ||
|
|
||
| To avoid warnings during the build for licensee versions of Unreal Engine, the `EngineVersion` key is not set in the `Sentry.uplugin` for the `github` package. |
Contributor
There was a problem hiding this comment.
Suggested change
| To avoid warnings during the build for licensee versions of Unreal Engine, the `EngineVersion` key is not set in the `Sentry.uplugin` for the `github` package. | |
| To avoid warnings during the build for license versions of Unreal Engine, the `EngineVersion` key is not set in the `Sentry.uplugin` for the `github` package. |
I might be reading that wrong tho.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces the following changes to Unreal SDK docs:
beforeBreadcrumbhook description (Add callback to pre-process breadcrumbs before adding sentry-unreal#814)EngineVersionkey in the plugin's descriptor file for GitHub package