UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FBaseCookedPackageWriter Class Reference

#include <BasePackageWriter.h>

+ Inheritance diagram for FBaseCookedPackageWriter:

Public Member Functions

virtual COREUOBJECT_API TUniquePtr< FLargeMemoryWriter > CreateLinkerArchive (FName PackageName, UObject *Asset, uint16 MultiOutputIndex) override
 
virtual COREUOBJECT_API TUniquePtr< FLargeMemoryWriter > CreateLinkerExportsArchive (FName PackageName, UObject *Asset, uint16 MultiOutputIndex) override
 
- Public Member Functions inherited from ICookedPackageWriter
virtual ~ICookedPackageWriter ()=default
 
virtual void SetCooker (UE::PackageWriter::Private::ICookerInterface *CookerInterface)=0
 
virtual FCookCapabilities GetCookCapabilities () const
 
virtual FDateTime GetPreviousCookTime () const
 
virtual ICookedPackageWriter * AsCookedPackageWriter () override
 
virtual void Initialize (const FCookInfo &Info)=0
 
virtual void BeginCook (const FCookInfo &Info)=0
 
virtual void EndCook (const FCookInfo &Info)=0
 
virtual TUniquePtr< FAssetRegistryState > LoadPreviousAssetRegistry ()=0
 
virtual FCbObject GetOplogAttachment (FName PackageName, FUtf8StringView AttachmentKey)=0
 
virtual void GetOplogAttachments (TArrayView< FName > PackageNames, TArrayView< FUtf8StringView > AttachmentKeys, TUniqueFunction< void(FName PackageName, FUtf8StringView AttachmentKey, FCbObject &&Attachment)> &&Callback)=0
 
virtual void GetBaseGameOplogAttachments (TArrayView< FName > PackageNames, TArrayView< FUtf8StringView > AttachmentKeys, TUniqueFunction< void(FName PackageName, FUtf8StringView AttachmentKey, FCbObject &&Attachment)> &&Callback)=0
 
virtual ECommitStatus GetCommitStatus (FName PackageName)=0
 
virtual void RemoveCookedPackages (TArrayView< const FName > PackageNamesToRemove)=0
 
virtual void RemoveCookedPackages ()=0
 
virtual void UpdatePackageModifiedStatus (FUpdatePackageModifiedStatusContext &Context)
 
virtual void UpdatePackageModificationStatus (FName PackageName, bool bIncrementallyUnmodified, bool &bInOutShouldIncrementallySkip)
 
virtual bool GetPreviousCookedBytes (const FPackageInfo &Info, FPreviousCookedBytesData &OutData)
 
virtual void CompleteExportsArchiveForDiff (FPackageInfo &Info, FLargeMemoryWriter &ExportsArchive)
 
virtual EPackageWriterResult BeginCacheForCookedPlatformData (FBeginCacheForCookedPlatformDataInfo &Info)
 
virtual void UpdateSaveArguments (FSavePackageArgs &SaveArgs)
 
virtual bool IsAnotherSaveNeeded (FSavePackageResultStruct &PreviousResult, FSavePackageArgs &SaveArgs)
 
virtual TFuture< FCbObject > WriteMPCookMessageForPackage (FName PackageName)=0
 
virtual bool TryReadMPCookMessageForPackage (FName PackageName, FCbObjectView Message)=0
 
virtual IPackageStoreWriter * AsPackageStoreWriter ()
 
virtual TMap< FName, TRefCountPtr< FPackageHashes > > & GetPackageHashes ()=0
 
- Public Member Functions inherited from IPackageWriter
virtual ~IPackageWriter ()=default
 
virtual FCapabilities GetCapabilities () const
 
virtual void BeginPackage (const FBeginPackageInfo &Info)=0
 
virtual void CommitPackage (FCommitPackageInfo &&Info)=0
 
virtual void WritePackageData (const FPackageInfo &Info, FLargeMemoryWriter &ExportsArchive, const TArray< FFileRegion > &FileRegions)=0
 
virtual void WriteBulkData (const FBulkDataInfo &Info, const FIoBuffer &BulkData, const TArray< FFileRegion > &FileRegions)=0
 
virtual void WriteAdditionalFile (const FAdditionalFileInfo &Info, const FIoBuffer &FileData)=0
 
virtual void WriteLinkerAdditionalData (const FLinkerAdditionalDataInfo &Info, const FIoBuffer &Data, const TArray< FFileRegion > &FileRegions)=0
 
virtual int64 GetExportsFooterSize ()
 
virtual void WritePackageTrailer (const FPackageTrailerInfo &Info, const FIoBuffer &Data)=0
 
virtual void RegisterDeterminismHelper (UObject *SourceObject, const TRefCountPtr< UE::Cook::IDeterminismHelper > &DeterminismHelper)
 
virtual bool IsPreSaveCompleted () const
 

Additional Inherited Members

- Public Types inherited from ICookedPackageWriter
enum class  EPackageHeaderFormat { PackageFileSummary , ZenPackageSummary }
 
using FBeginCacheForCookedPlatformDataInfo = UE::PackageWriter::Private::FBeginCacheForCookedPlatformDataInfo
 
typedef TUniqueFunction< EPackageWriterResult(FBeginCacheForCookedPlatformDataInfo &Info)> FBeginCacheCallback
 
typedef TUniqueFunction< void(UObject *SourceObject, const TRefCountPtr< UE::Cook::IDeterminismHelper > &DeterminismHelper)> FRegisterDeterminismHelperCallback
 
- Public Types inherited from IPackageWriter
enum class  EWriteOptions {
  None = 0 , WritePackage = 0x01 , WriteSidecars = 0x02 , Write = WritePackage | WriteSidecars ,
  ComputeHash = 0x04 , SaveForDiff = 0x08
}
 
enum class  ECommitStatus {
  Success , Canceled , NothingToCook , Error ,
  NotCommitted
}
 

Detailed Description

Shared Implementation for ICookedPackageWriters.

Member Function Documentation

◆ CreateLinkerArchive()

TUniquePtr< FLargeMemoryWriter > FBaseCookedPackageWriter::CreateLinkerArchive ( FName  PackageName,
UObject *  Asset,
uint16  MultiOutputIndex 
)
overridevirtual

Create the FLargeMemoryWriter to which the Header and Exports are written during the save.

Implements IPackageWriter.

◆ CreateLinkerExportsArchive()

TUniquePtr< FLargeMemoryWriter > FBaseCookedPackageWriter::CreateLinkerExportsArchive ( FName  PackageName,
UObject *  Asset,
uint16  MultiOutputIndex 
)
overridevirtual

Returns an archive to be used when serializing exports.

Implements IPackageWriter.

The documentation for this class was generated from the following files: