|
| 1 | +--- |
| 2 | +title: Migration Guide |
| 3 | +description: "Learn more about migrating to the current version." |
| 4 | +sidebar_order: 8000 |
| 5 | +--- |
| 6 | + |
| 7 | +## Migrating to 1.0.0 |
| 8 | + |
| 9 | +### Breaking changes |
| 10 | + |
| 11 | +#### Sentry Classes Instantiation |
| 12 | + |
| 13 | +Sentry class objects created via `NewObject<T>` in C++ or `ConstructObjectFromClass` in Blueprints now require an explicit call to their `Initialize` method (if available) before use. In Blueprints, it's recommended to use the provided Sentry library functions to create these entities as they automatically call `Initialize` and return a fully initialized, ready-to-use object. |
| 14 | + |
| 15 | +#### Cleanup Public Classes |
| 16 | + |
| 17 | +We cleaned up our public API by removing a few functions and classes to streamline the SDK and remove ambiguities. The following changes were made: |
| 18 | + |
| 19 | +- Removed `USentryId` class and replaced its usages with `FString` |
| 20 | +- Removed `SentrySubsystem::ConfigureScope` function |
| 21 | +- Removed `USentryLibrary::StringToBytesArray` function |
| 22 | +- Removed `USentryLibrary::ByteArrayToString` function |
| 23 | +- Removed `USentryLibrary::SaveStringToFile` function |
| 24 | +- Removed `USentryScope::SetEnvironment` function |
| 25 | +- Removed `USentryScope::GetEnvironment` function |
| 26 | +- Removed `USentryScope::SetDist` function |
| 27 | +- Removed `USentryScope::GetDist` function |
| 28 | + |
| 29 | +### Issue Grouping |
| 30 | + |
| 31 | +The Unreal SDK no longer modifies call stacks for assertion events by trimming the topmost frames related to the engine's internal assertion handling logic. This was previously done to work around the case where all assertions were grouped into a single Sentry issue. With this change, issue grouping is now fully handled by the Sentry server. |
| 32 | + |
| 33 | +### SDK Configuration Changes |
| 34 | + |
| 35 | +- The <PlatformIdentifier name="environment" /> and <PlatformIdentifier name="dist" /> properties must now be set in the plugin settings and can no longer be modified programmatically via scope configuration. |
| 36 | + |
| 37 | +- Sentry can no longer be disabled for specific platforms using the Enable for Build Platform Types option in the plugin settings (`General -> Misc`) or the EnableTargetPlatforms property in the project configuration file. |
| 38 | + |
| 39 | +### Crash Reporter Changes |
| 40 | + |
| 41 | +The `Epic Account Id` and `Login Id` are no longer included in the `Crash Info` context for crashes captured on Windows and Linux using the default Crash Reporter. These fields are intended for internal use by Epic Games and provide no meaningful value externally. |
| 42 | + |
| 43 | +## Migrating to 0.19.0 |
| 44 | + |
| 45 | +### Breaking changes |
| 46 | + |
| 47 | +- Renamed `OnError` delagate property of `FSentryOutputDeviceError` class to `OnAssert` |
| 48 | + |
| 49 | +## Migrating to 0.15.0 |
| 50 | + |
| 51 | +### Breaking changes |
| 52 | + |
| 53 | +To enable capturing editor crashes `USentrySubsystem` base class has been changed to `UEngineSubsystem`. |
| 54 | + |
| 55 | +- If you're using the plugin's Blueprint API, you will need to recreate all `Get Sentry Subsystem` nodes. |
| 56 | +- If you're using the plugin's C++ API, update your implementation to access `USentrySubsystem` via the `GEngine` pointer. |
0 commit comments