FLinkerSave

Handles saving Unreal package files.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FLinker

FArchiveUObject

FLinkerSave

References

Module	CoreUObject
Header	/Engine/Source/Runtime/CoreUObject/Public/UObject/LinkerSave.h
Include	#include "UObject/LinkerSave.h"

Syntax

class FLinkerSave :
public FLinker,
public FArchiveUObject

Remarks

Handles saving Unreal package files.

Variables

	Name	Description
TArray< Additio...	AdditionalDataToAppend	Array of callbacks that will be invoked when it is possible to serialize out data to the end of the output file.
bool	bProceduralSave	Set to true when the package is being saved due to a procedural save.
TArray< FBulkDa...	BulkDataToAppend
bool	bUpdatingLoadedPath	Set to true when the LoadedPath of the package being saved is being updated.
FPackageIndex	CurrentlySavingExport
TArray< FPackag...	DepListForErrorChecking
TArray< FFileRe...	FileRegions
TMap< FNameEntr...	NameIndices	Index array - location of the name in the NameMap array for each FName is stored in the NameIndices array using the FName's Index
TMap< UObject &...	ObjectIndicesMap	Index array - location of the resource for a UObject is stored in the ObjectIndices array using the UObject's Index
TUniquePtr< UE:...	PackageTrailerBuilder	Gathers all payloads while save the package, so that they can be stored in a single data structure
TArray< TUnique...	PostSaveCallbacks	Array of callbacks that will be invoked when the package has successfully saved to disk.
TRefCountPtr< F...	SaveContext	Save context associated with this linker
FArchive *	Saver	Variables.
TMap< const UOb...	SearchableNamesObjectMap	List of Searchable Names, by object containing them. This gets turned into package indices later
TArray< FSideca...	SidecarDataToAppend	Used by FVirtualizedUntypedBulkData to add payloads to be added to the payload sidecar file (currently an experimental feature)

Constructors

	Name	Description
	FLinkerSave ( UPackage* InParent, bool bForceByteSwapping, bool bInSaveUnversioned )	Constructor for memory writer
	FLinkerSave ( UPackage* InParent, const TCHAR* InFilename, bool bForceByteSwapping, bool bInSaveUnversioned )	Constructor for file writer
	FLinkerSave ( UPackage* InParent, FArchive* InSaver, bool bForceByteSwapping, bool bInSaveUnversioned )	Constructor for custom savers. The linker assumes ownership of the custom saver.

Destructors

	Name	Description
	~FLinkerSave()

Functions

	Name	Description
bool	CloseAndDestroySaver()	Closes and deletes the Saver (file, memory or custom writer) which will close any associated file handle.
const FStrin...	GetFilename()	Get the filename being saved to
FOutputDevic...	GetOutputDevice()	Returns an output Device that can be used to log info, warnings and errors etc.
int32	MapName ( FNameEntryId Name )	Returns the appropriate name index for the source name, or 0 if not found in NameIndices
FPackageInde...	MapObject ( const UObject* Object )	Returns the appropriate package index for the source object, or default value if not found in ObjectIndicesMap
void	OnPostSave ( const FPackagePath& PackagePath, FObjectPostSaveContext ObjectSaveCo... )	Invoke all of the callbacks in PostSaveCallbacks and then empty it.
void	SetFilename ( FStringView InFilename )	Set the filename being saved to
void	SetOutputDevice ( FOutputDevice* InOutputDevice )	Set the output device used to log errors, if any.
ELinkerType:...	StaticType()
void	ThisRequiresLocalizationGather()	Sets a flag indicating that this archive contains data required to be gathered for localization.

Overridden from FLinker

		Name	Description
	FString	GetDebugName()	Returns a descriptor of the PackagePath this Linker is reading from or writing to, usable for an identifier in warning and log messages

Overridden from FArchive

	Name	Description
void	PopDebugDataString()
void	PushDebugDataString ( const FName& DebugData )	Proxy for debugdata
void	Seek ( int64 InPos )	Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.
void	Serialize ( void* V, int64 Length )
void	UsingCustomVersion ( const FGuid& Guid )	Registers the custom version to the archive.

Overridden from FArchiveState

	Name	Description
FString	GetArchiveName()	Returns the name of the Archive.
FLinker *...	GetLinker()	If this archive is a FLinkerLoad or FLinkerSave, returns a pointer to the FLinker portion.
FUObjectSeri...	GetSerializeContext()	Gets the current UObject serialization context for this archive.
void	SetSerializeContext ( FUObjectSerializeContext* InLo... )	Sets the current UObject serialization context for this archive.
void	SetUseUnversionedPropertySerialization ( bool bInUseUnversioned )	Sets whether tagged property serialization should be replaced by faster unversioned serialization.
int64	Tell()	Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location.

Operators

	Name	Description
FArchive &	operator<< ( FName& Value )	Serializes an FName value from or into this archive.
FArchive &	operator<< ( FLazyObjectPtr& Value )	Serializes a lazy object pointer value from or into this archive.
FArchive &	operator<< ( UObject*& Value )	Serializes an UObject value from or into this archive.

Classes

	Name	Description
	FBulkDataStorageInfo	List of bulkdata that needs to be stored at the end of the file
	FSidecarStorageInfo

Typedefs

Name	Description
AdditionalDataCallback	Callback for arbitrary serializers to append data to the end of the ExportsArchive.

Constants

Name	Description
PackagesToScriptSHAMap	A mapping of package name to generated script SHA keys