1. Epic GamesDeveloper
  3. ILevelSnapshotsModule

ILevelSnapshotsModule

API > API/Plugins > API/Plugins/LevelSnapshots

   
Name ILevelSnapshotsModule
Type class
Header File /Engine/Plugins/VirtualProduction/LevelSnapshots/Source/LevelSnapshots/Public/ILevelSnapshotsModule.h
Include Path #include "ILevelSnapshotsModule.h"

Syntax

class ILevelSnapshotsModule : public IModuleInterface

Implements Interfaces

Classes

Name Remarks
FPostTakeSnapshotEvent  
FPreTakeSnapshotEvent  

Typedefs

Name Type Remarks Include Path
FCanTakeSnapshot TBaseDelegate_OneParam< bool, const FPreTakeSnapshotEventData & >   ILevelSnapshotsModule.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddCanTakeSnapshotDelegate ( FName DelegateName,
FCanTakeSnapshot Delegate
)

 Add a named delegate that determines if we can take a snapshot. ILevelSnapshotsModule.h  

void AddExplicitilySupportedProperties ( const TSet< const FProperty* >& Properties
)

 Adds properties that snapshots will capture and restore from now on. ILevelSnapshotsModule.h  

void AddExplicitlyUnsupportedProperties ( const TSet< const FProperty* >& Properties
)

 Stops snapshots from capturing / restoring these properties. ILevelSnapshotsModule.h  

void AddSkippedClassDefault ( const UClass* Class
)

 Disable CDO serialization for a class and all of its subclasses. ILevelSnapshotsModule.h  

void AddSkippedSubobjectClasses ( const TSet< UClass* >& Classes
)

 Snapshots will no longer capture nor restore subobjects of this class. ILevelSnapshotsModule.h  

bool CanTakeSnapshot ( const FPreTakeSnapshotEventData& Event
) const

 Queries the attached snapshot delegate and determines if we can take a snapshot. ILevelSnapshotsModule.h  

FPostTakeSnapshotEvent & OnPostTakeSnapshot()

 Called after a snapshot is taken ILevelSnapshotsModule.h  

FPreTakeSnapshotEvent & OnPreTakeSnapshot()

 Called before a snapshot is taken. ILevelSnapshotsModule.h  

void RegisterCustomObjectSerializer ( UClass* Class,
TSharedRef< ICustomObjectSnapshotSerializer > CustomSerializer,
bool bIncludeBlueprintChildClasses
)

 Registers callbacks for snapshotting / restoring certain classes. ILevelSnapshotsModule.h  

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. ILevelSnapshotsModule.h  

void RegisterPropertyComparer ( UClass* Class,
TSharedRef< IPropertyComparer > Comparer
)

 Registers a callback for deciding whether a property should be considered changed. ILevelSnapshotsModule.h  

void RegisterRestorabilityOverrider ( TSharedRef< ISnapshotRestorabilityOverrider > Overrider
)

 Registers callbacks that override which actors, components, and properties are restored by default. ILevelSnapshotsModule.h  

void RegisterRestorationListener ( TSharedRef< IRestorationListener > Listener
)

 Registers an object that will receive callbacks when a snapshot is applied. ILevelSnapshotsModule.h  

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. ILevelSnapshotsModule.h  

void RegisterSnapshotLoader ( TSharedRef< ISnapshotLoader > Loader
)

 Register an object that will receive callbacks when a snapshot is loaded ILevelSnapshotsModule.h  

void RegisterTakeSnapshotListener ( TSharedRef< ITakeSnapshotListener > Extender
)

 Registers an object that listens for when objects are snapshot. ILevelSnapshotsModule.h  

void RemoveAdditionallySupportedProperties ( const TSet< const FProperty* >& Properties
)

   ILevelSnapshotsModule.h  

void RemoveCanTakeSnapshotDelegate ( FName DelegateName
)

 Remove previously added named delegate that determines if we can take a snapshot. ILevelSnapshotsModule.h  

void RemoveExplicitlyUnsupportedProperties ( const TSet< const FProperty* >& Properties
)

   ILevelSnapshotsModule.h  

void RemoveSkippedClassDefault ( const UClass* Class
)

   ILevelSnapshotsModule.h  

void RemoveSkippedSubobjectClasses ( const TSet< UClass* >& Classes
)

   ILevelSnapshotsModule.h  

bool ShouldSkipClassDefaultSerialization ( const UClass* Class
) const

   ILevelSnapshotsModule.h  

void UnregisterCustomObjectSerializer ( UClass* Class
)

   ILevelSnapshotsModule.h  

void UnregisterGlobalActorFilter ( const TSharedRef< IActorSnapshotFilter >& Filter
)

   ILevelSnapshotsModule.h  

void UnregisterPropertyComparer ( UClass* Class,
const TSharedRef< IPropertyComparer >& Comparer
)

   ILevelSnapshotsModule.h  

void UnregisterRestorabilityOverrider ( const TSharedRef< ISnapshotRestorabilityOverrider >& Overrider
)

 Unregisters an overrider previously registered. ILevelSnapshotsModule.h  

void UnregisterRestorationListener ( const TSharedRef< IRestorationListener >& Listener
)

   ILevelSnapshotsModule.h  

void UnregisterSnapshotFilterExtender ( const TSharedRef< ISnapshotFilterExtender >& Listener
)

   ILevelSnapshotsModule.h  

void UnregisterSnapshotLoader ( const TSharedRef< ISnapshotLoader >& Loader
)

   ILevelSnapshotsModule.h  

void UnregisterTakeSnapshotListener ( const TSharedRef< ITakeSnapshotListener >& Listener
)

   ILevelSnapshotsModule.h  

Static

Name Remarks Include Path Unreal Specifiers

static ILevelSnapshotsModule & Get()

   ILevelSnapshotsModule.h  

static bool IsAvailable()

   ILevelSnapshotsModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page