Navigation
API > API/Plugins > API/Plugins/LevelSnapshots
External modules can implement this interface to customise how specific classes are snapshot and restored. Implementations of this interface can be registered with the Level Snapshots module.
One instance handles on type of class.
ISnapshotObjectSerializer handles the serialisation of the object you're registered to. You can use it to add custom annotation data you need to restoring object info. You can also save & restore subobjects you wish to manually restore, provided they're not automatically restored by Level Snapshots. The following subobjects are handled by default:
- Actor components
| Name | ICustomObjectSnapshotSerializer |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/LevelSnapshots/Source/LevelSnapshots/Public/Restorability/Interfaces/ICustomObjectSnapshotSerializer.h |
| Include Path | #include "Restorability/Interfaces/ICustomObjectSnapshotSerializer.h" |
Syntax
class ICustomObjectSnapshotSerializer
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ICustomObjectSnapshotSerializer() |
Restorability/Interfaces/ICustomObjectSnapshotSerializer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UObject * FindOrRecreateSubobjectInEditorWorld
(
UObject* EditorObject, |
Called when applying into the editor world. | Restorability/Interfaces/ICustomObjectSnapshotSerializer.h | |
virtual UObject * FindOrRecreateSubobjectInSnapshotWorld
(
UObject* SnapshotObject, |
Called when creating objects for the temporary snapshot world. | Restorability/Interfaces/ICustomObjectSnapshotSerializer.h | |
virtual UObject * FindSubobjectInEditorWorld
(
UObject* EditorObject, |
Similar to FindOrRecreateSubobjectInEditorWorld, only that the subobject is not recreated if not present. | Restorability/Interfaces/ICustomObjectSnapshotSerializer.h | |
virtual void OnPostSerializeEditorSubobject
(
UObject* Subobject, |
Optional. | Restorability/Interfaces/ICustomObjectSnapshotSerializer.h | |
virtual void OnPostSerializeSnapshotSubobject
(
UObject* Subobject, |
Optional. | Restorability/Interfaces/ICustomObjectSnapshotSerializer.h | |
virtual void OnTakeSnapshot
(
UObject* EditorObject, |
Called when taking a snapshot of an object with the class this implementation is registered to. | Restorability/Interfaces/ICustomObjectSnapshotSerializer.h | |
virtual void PostApplyToEditorObject
(
UObject* Object, |
Optional. | Restorability/Interfaces/ICustomObjectSnapshotSerializer.h | |
virtual void PostApplyToSnapshotObject
(
UObject* Object, |
Optional. | Restorability/Interfaces/ICustomObjectSnapshotSerializer.h | |
virtual void PreApplyToEditorObject
(
UObject* Object, |
Optional. | Restorability/Interfaces/ICustomObjectSnapshotSerializer.h | |
virtual void PreApplyToSnapshotObject
(
UObject* Object, |
Optional. | Restorability/Interfaces/ICustomObjectSnapshotSerializer.h |