1. Epic GamesDeveloper
  3. FLinkerSave

FLinkerSave

Handles saving Unreal package files.

Unreal Engine C++ API Reference > Runtime > CoreUObject > UObject

Inheritance Hierarchy

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

  Type Name Description
Public variable TArray< AdditionalDataCallback > AdditionalDataToAppend Array of callbacks that will be invoked when it is possible to serialize out data to the end of the output file.
Public variable bool bIsWritingHeader Flag that indicate if we are currently serializing the package header.
Public variable bool bProceduralSave Set to true when the package is being saved due to a procedural save.
Public variable bool bRehydratePayloads When set to true, payloads that are currently virtualized should be downloaded and stored locally with the package
Public variable bool bUpdatingLoadedPath Set to true when the LoadedPath of the package being saved is being updated.
Public variable FPackageIndex CurrentlySavingExport  
Public variable UObject * CurrentlySavingExportObject  
Public variable TArray< FPackageIndex > DepListForErrorChecking  
Public variable TArray< FFileRegion > FileRegions  
Public variable TMap< FNameEntryId, int32 > NameIndices Map from FName to the index of the name in the name array written into the package header.
Public variable TMap< TObjectPtr< UObject >, FPackageIndex > ObjectIndicesMap Index array - location of the resource for a UObject is stored in the ObjectIndices array using the UObject's Index
Public variable TUniquePtr< UE::FPackageTrailerBuilder > PackageTrailerBuilder Gathers all payloads while save the package, so that they can be stored in a single data structure
Public variable TArray< TUniqueFunction< void(const FPackagePath &PackagePath, FObjectPostSaveContext ObjectSaveCont... PostSaveCallbacks Array of callbacks that will be invoked when the package has successfully saved to disk.
Public variable TRefCountPtr< FUObjectSerializeContext > SaveContext Save context associated with this linker
Public variable FArchive * Saver Variables.
Public variable TMap< const UObject *, TArray< FName > > SearchableNamesObjectMap List of Searchable Names, by object containing them. This gets turned into package indices later
Public variable TArray< FSidecarStorageInfo > SidecarDataToAppend Used by FEditorBulkData to add payloads to be added to the payload sidecar file (currently an experimental feature)
Public variable TMap< FSoftObjectPath, int32 > SoftObjectPathIndices Map from FSoftObjectPath to the index of the path in the soft object path array written into the package header.

Constructors

  Type Name Description
Public function  

FLinkerSave ( UPackage* InParent,
bool bForceByteSwapping,
bool bInSaveUnversioned
)

 Constructor for memory writer
Public function  

FLinkerSave ( UPackage* InParent,
const TCHAR* InFilename,
bool bForceByteSwapping,
bool bInSaveUnversioned
)

 Constructor for file writer
Public function  

FLinkerSave ( UPackage* InParent,
FArchive* InSaver,
bool bForceByteSwapping,
bool bInSaveUnversioned
)

 Constructor for custom savers. The linker assumes ownership of the custom saver.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function UE::FDerivedData Adds the derived data to the package. This is only supported when saving a cooked package.
Public function bool Closes and deletes the Saver (file, memory or custom writer) which will close any associated file handle.
Public function FFileRegionMemoryWriter &  
Public function Const const FString & Get the filename being saved to
Public function FFileRegionMemoryWriter &  
Public function FFileRegionMemoryWriter &  
Public function Const FOutputDevice * Returns an output Device that can be used to log info, warnings and errors etc.
Public function Const int32 Returns the appropriate name index for the source name, or INDEX_NONE if not found in NameIndices
Public function Const FPackageIndex

MapObject ( TObjectPtr< const UObject > Object
)

 Returns the appropriate package index for the source object, or default value if not found in ObjectIndicesMap
Public function Const int32

MapSoftObjectPath ( const FSoftObjectPath& SoftObjectPath
)

 Returns the appropriate soft object path index for the source soft object path, or INDEX_NONE if not found.
Public function void

OnPostSave ( const FPackagePath& PackagePath,
FObjectPostSaveContext ObjectSaveContext
)

 Invoke all of the callbacks in PostSaveCallbacks and then empty it.
Public function void Triggered after bulk data payloads has been serialized to disk/package writer.
Public function Virtual bool  
Public function void Sets whether a separate file regions should be declared for each bulkdata
Protected function void

SetFilename ( FStringView InFilename
)

 Set the filename being saved to
Public function void

SetFileRegionsEnabled ( bool bEnabled
)

 Sets whether file regions will be written or not.
Public function void

SetMemoryMapAlignment ( int64 InAlignment
)

 Set target platform memory map alignment. A negative value disables memory mapped bulk data.
Public function void

SetOutputDevice ( FOutputDevice* InOutputDevice
)

 Set the output device used to log errors, if any.
Public function void

SetSaveBulkDataByReference ( bool bValue
)

 Sets whether saving bulk data by reference, i.e. leaving the bulk data payload in the original .uasset file when using EditorDomain.
Public function void Sets whether bulk data will be stored in the Linker archive (.uasset) or in sepearate files (.ubulk, .m.ubulk, .opt.ubulk) .
Public function void

SetTransientPropertyOverrides ( const TMap< UObject*, TSet< FProperty* >>& InTransientPropertyOverrides
)

 Sets the map of overrided properties for each export that should be treated as transient, and nulled out when serializing
Public function Static ELinkerType::Type  
Public function void Sets a flag indicating that this archive contains data required to be gathered for localization.

Overridden from FLinker

  Type Name Description
Public function Virtual Const FString 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

  Type Name Description
Public function Virtual void  
Public function Virtual void

PushDebugDataString ( const FName& DebugData
)

 Proxy for debugdata
Public function Virtual void

Seek ( int64 InPos
)

 Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.
Public function Virtual void

Serialize ( void* V,
int64 Length
)

  
Public function Virtual void

UsingCustomVersion ( const FGuid& Guid
)

 Registers the custom version to the archive.

Overridden from FArchiveState

  Type Name Description
Public function Virtual Const FString Returns the name of the Archive.
Public function Virtual FLinker * If this archive is a FLinkerLoad or FLinkerSave, returns a pointer to the FLinker portion.
Public function Virtual FUObjectSerializeContext * Gets the current UObject serialization context for this archive.
Public function Virtual void

SetFilterEditorOnly ( bool bInFilterEditorOnly
)

 Sets whether we should be filtering editor only.
Public function Virtual void Sets the current UObject serialization context for this archive.
Public function Virtual void

SetUseUnversionedPropertySerialization ( bool bInUseUnversioned
)

 Sets whether tagged property serialization should be replaced by faster unversioned serialization.
Public function Virtual Const bool

ShouldSkipProperty ( const FProperty* InProperty
)

 Checks whether the archive wants to skip the property independent of the other flags
Public function Virtual 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

  Type Name Description
Public function Virtual FArchive &

operator<< ( UObject*& Value
)

 Serializes an UObject value from or into this archive.
Public function Virtual FArchive &

operator<< ( FName& Value
)

 Serializes an FName value from or into this archive.
Public function Virtual FArchive & Serializes a lazy object pointer value from or into this archive.
Public function Virtual FArchive & Serializes soft object paths from or into this archive.

Classes

  Type Name Description
Public struct 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page