1. Epic GamesDeveloper
  3. ULevelSnapshot

ULevelSnapshot

Holds the state of a world at a given time.

API > API/Plugins > API/Plugins/LevelSnapshots > API/Plugins/LevelSnapshots/Data

Inheritance Hierarchy

References

   
Module LevelSnapshots
Header /Engine/Plugins/VirtualProduction/LevelSnapshots/Source/LevelSnapshots/Public/Data/LevelSnapshot.h
Include #include "Data/LevelSnapshot.h"

Syntax

UCLASS&40;BlueprintType&41;  
class ULevelSnapshot : public UObject

Remarks

Holds the state of a world at a given time. This asset can be used to rollback certain properties in a UWorld.

Functions

  Type Name Description
Public function void

ApplySnapshotToWorld ( UWorld* TargetWorld,
const FPropertySelectionMap& SelectionSet
)

 Applies this snapshot to the given world.
Public function Const FString

GetActorLabel ( const FSoftObjectPath& OriginalActorPath
)

 Gets the display label of the path of the actor.
Public function Const const FSnapshotDataCache &  
Public function Const UFunction BlueprintPure, Category FDateTime  
Public function TOptional< TNonNullPtr< AActor > >

GetDeserializedActor ( const FSoftObjectPath& OriginalActorPath
)

 Given an actor path in the world, gets the equivalent actor from the snapshot.
Public function Const UFunction BlueprintPure, Category FSoftObjectPath  
Public function Const int32 Gets the number of actors saved by this snapshot.
Public function Const const FWorldSnapshotData &  
Public function Const UFunction BlueprintPure, Category FString  
Public function Const UFunction BlueprintPure, Category FName  
Public function bool Checks whether the given actor has changes to the snapshot version.
Public function bool Checks whether the original actor has any properties that changed since the snapshot was taken by comparing properties.
Public function FSnapshotEvent &  
Public function FSnapshotEvent &  
Public function void Clears the diff state of the actor.
Public function void Clears the diff state of the actor.
Public function UFunction BlueprintCallable, Category void

SetSnapshotDescription ( const FString& InSnapshotDescription
)

  
Public function UFunction BlueprintCallable, Category void

SetSnapshotName ( const FName& InSnapshotName
)

 Sets the name of this snapshot.
Public function bool

SnapshotWorld ( UWorld* TargetWorld
)

 Captures the current state of the given world.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.

Typedefs

Name Description
FActorConsumer  
FActorPathConsumer  
FSnapshotEvent  

Deprecated Functions

  Type Name Description
Public function void

DiffWorld ( UWorld* World,
FActorConsumer HandleMatchedActor,
FActorPathConsumer HandleRemovedActor,
FActorConsumer HandleAddedActor
)

 Use DiffWorld that accepts FActorConsumer for HandleMatchedActor instead.
Public function void

DiffWorld ( UWorld* World,
FActorPathConsumer HandleMatchedActor,
FActorPathConsumer HandleRemovedActor,
FActorConsumer HandleAddedActor
)

 Use DiffWorld that accepts FActorConsumer for HandleMatchedActor instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page