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

Light Theme

Dark Theme

FLinkerSave

Handles saving Unreal package files.

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< FBulkDa...	BulkDataToAppend
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
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

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.
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
ELinkerType:...	StaticType()
void	ThisRequiresLocalizationGather()	Sets a flag indicating that this archive contains data required to be gathered for localization.

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

Constants

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

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

Take our survey

Dismiss