Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > LevelSnapshots > Data > FWorldSnapshotData

Light Theme

Dark Theme

FWorldSnapshotData

Holds saved world data and handles all logic related to writing to the existing world.

Windows

MacOS

Linux

References

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

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FWorldSnapshotData

Remarks

Holds saved world data and handles all logic related to writing to the existing world.

Variables

		Name	Description
	friend	FActorSnapshotData
	friend	FSnapshotArchive

Functions

	Name	Description
void	AddClassDefault ( UClass* Class )
int32	AddObjectDependency ( UObject* ReferenceFromOriginal... )	Adds an object dependency without serializing the object's content.
int32	AddSubobjectDependency ( UObject* ReferenceFromOriginal... )	Adds a subobject dependency.
void	ApplyToWorld ( UWorld* WorldToApplyTo, UPackage* LocalisationSnapshot..., const FPropertySelectionMap& Prope... )	Applies the saved properties to WorldActor
bool	AreReferencesEquivalent ( UObject* SnapshotPropertyValue, UObject* OriginalPropertyValue, AActor* SnapshotActor, AActor* OriginalActor )	Checks whether two pointers point to "equivalent" objects.
void	ForEachOriginalActor ( TFunction< void... )
UObject *...	GetClassDefault ( UClass* Class )
TOptional< A...	GetDeserializedActor ( const FSoftObjectPath& OriginalObj..., UPackage* LocalisationSnapshot... )	Given a path to a world actor, gets the equivalent allocated actor.
int32	GetNumSavedActors()
TOptional< F...	GetSerializedClassDefaults ( UClass* Class )	Gets the state of the CDO from when the snapshot was taken.
const FSnaps...	GetSnapshotVersionInfo()
bool	HasMatchingSavedActor ( const FSoftObjectPath& OriginalObj... )
void	OnCreateSnapshotWorld ( UWorld* NewTempActorWorld )
void	OnDestroySnapshotWorld()
void	PostSerialize ( const FArchive& Ar )
UObject *...	ResolveObjectDependencyForClassDefaultObject ( int32 ObjectPathIndex )	Resolves an object depedency when restoring a class default object.
UObject *...	ResolveObjectDependencyForEditorWorld ( int32 ObjectPathIndex, const FPropertySelectionMap& Selec... )	Resolves an object dependency for use in the editor world.
UObject *...	ResolveObjectDependencyForSnapshotWorld ( int32 ObjectPathIndex )	Resolves an object dependency for use in the snapshot world.
void	SerializeClassDefaultsInto ( UObject* Object )	Gets the Object's class and serializes the saved CDO into it.
void	SnapshotWorld ( UWorld* World )	Records the actor in this snapshot

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss