Navigation
API > API/Plugins > API/Plugins/LevelSnapshots
Inheritance Hierarchy
- IModuleInterface
- ILevelSnapshotsModule
References
| Module | LevelSnapshots |
| Header | /Engine/Plugins/VirtualProduction/LevelSnapshots/Source/LevelSnapshots/Public/ILevelSnapshotsModule.h |
| Include | #include "ILevelSnapshotsModule.h" |
Syntax
class ILevelSnapshotsModule : public IModuleInterface
Variables
| Type | Name | Description | |
|---|---|---|---|
| FPostTakeSnapshotEvent | PostTakeSnapshot | ||
| FPreTakeSnapshotEvent | PreTakeSnapshot |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddCanTakeSnapshotDelegate
(
FName DelegateName, |
Add a named delegate that determines if we can take a snapshot. | |
| void | AddExplicitilySupportedProperties
(
const TSet< const FProperty* >& Properties |
Adds properties that snapshots will capture and restore from now on. | |
| void | AddExplicitlyUnsupportedProperties
(
const TSet< const FProperty* >& Properties |
Stops snapshots from capturing / restoring these properties. | |
| void | AddSkippedClassDefault
(
const UClass* Class |
Disable CDO serialization for a class and all of its subclasses. | |
| void | AddSkippedSubobjectClasses
(
const TSet< UClass* >& Classes |
Snapshots will no longer capture nor restore subobjects of this class. | |
| bool | CanTakeSnapshot
(
const FPreTakeSnapshotEventData& Event |
Queries the attached snapshot delegate and determines if we can take a snapshot. | |
| ILevelSnapshotsModule & | Get () |
||
| bool | IsAvailable () |
||
| FPostTakeSnapshotEvent & | Called after a snapshot is taken | ||
| FPreTakeSnapshotEvent & | Called before a snapshot is taken. | ||
| void | RegisterCustomObjectSerializer
(
UClass* Class, |
Registers callbacks for snapshotting / restoring certain classes. | |
| void | RegisterGlobalActorFilter
(
TSharedRef< IActorSnapshotFilter > Filter |
Registers callbacks for external systems to decide whether a given actor can be modified, recreated, or removed from the world. | |
| void | RegisterPropertyComparer
(
UClass* Class, |
Registers a callback for deciding whether a property should be considered changed. | |
| void | RegisterRestorabilityOverrider
(
TSharedRef< ISnapshotRestorabilityOverrider > Overrider |
Registers callbacks that override which actors, components, and properties are restored by default. | |
| void | RegisterRestorationListener
(
TSharedRef< IRestorationListener > Listener |
Registers an object that will receive callbacks when a snapshot is applied. | |
| void | RegisterSnapshotFilterExtender
(
TSharedRef< ISnapshotFilterExtender > Extender |
Registers an object that can decide to display additional properties to the user that default snapshot behaviour does not display. | |
| void | RegisterSnapshotLoader
(
TSharedRef< ISnapshotLoader > Loader |
Register an object that will receive callbacks when a snapshot is loaded | |
| void | RegisterTakeSnapshotListener
(
TSharedRef< ITakeSnapshotListener > Extender |
Registers an object that listens for when objects are snapshot. | |
| void | RemoveAdditionallySupportedProperties
(
const TSet< const FProperty* >& Properties |
||
| void | RemoveCanTakeSnapshotDelegate
(
FName DelegateName |
Remove previously added named delegate that determines if we can take a snapshot. | |
| void | RemoveExplicitlyUnsupportedProperties
(
const TSet< const FProperty* >& Properties |
||
| void | RemoveSkippedClassDefault
(
const UClass* Class |
||
| void | RemoveSkippedSubobjectClasses
(
const TSet< UClass* >& Classes |
||
| bool | ShouldSkipClassDefaultSerialization
(
const UClass* Class |
||
| void | UnregisterCustomObjectSerializer
(
UClass* Class |
||
| void | UnregisterGlobalActorFilter
(
const TSharedRef< IActorSnapshotFilter >& Filter |
||
| void | UnregisterPropertyComparer
(
UClass* Class, |
||
| void | UnregisterRestorabilityOverrider
(
const TSharedRef< ISnapshotRestorabilityOverrider >& Overrider |
Unregisters an overrider previously registered. | |
| void | UnregisterRestorationListener
(
const TSharedRef< IRestorationListener >& Listener |
||
| void | UnregisterSnapshotFilterExtender
(
const TSharedRef< ISnapshotFilterExtender >& Listener |
||
| void | UnregisterSnapshotLoader
(
const TSharedRef< ISnapshotLoader >& Loader |
||
| void | UnregisterTakeSnapshotListener
(
const TSharedRef< ITakeSnapshotListener >& Listener |
Classes
| Type | Name | Description | |
|---|---|---|---|
| FPostTakeSnapshotEvent | |||
| FPreTakeSnapshotEvent |
Typedefs
| Name | Description |
|---|---|
| FCanTakeSnapshot |