1. Epic GamesDeveloper
  3. ICookedPackageWriter

ICookedPackageWriter

Interface for cooking that writes cooked packages to storage usable by the runtime game.

API > API/Runtime > API/Runtime/Core

Interface for cooking that writes cooked packages to storage usable by the runtime game.

   
Name ICookedPackageWriter
Type class
Header File /Engine/Source/Runtime/Core/Public/Serialization/PackageWriter.h
Include Path #include "Serialization/PackageWriter.h"

Syntax

class ICookedPackageWriter : public IPackageWriter

Implements Interfaces

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ICookedPackageWriter()

   Serialization/PackageWriter.h  

Structs

Name Remarks
FCookCapabilities  
FCookInfo  
FDeleteByFree  
FPreviousCookedBytesData  
FReferencedPluginsInfo  
FUpdatePackageModifiedStatusContext  

Enums

Public

Name Remarks
EPackageHeaderFormat  

Typedefs

Name Type Remarks Include Path
FBeginCacheCallback TUniqueFunction< EPackageWriterResult(FBeginCacheForCookedPlatformDataInfo &Info)> Helper callback type for Writers that need to send the message on to UCookOnTheFlyServer Serialization/PackageWriter.h
FBeginCacheForCookedPlatformDataInfo UE::PackageWriter::Private::FBeginCacheForCookedPlatformDataInfo   Serialization/PackageWriter.h
FRegisterDeterminismHelperCallback TUniqueFunction< void(UObject *SourceObject, const TRefCountPtr< UE::Cook::IDeterminismHelper > &DeterminismHelper)>   Serialization/PackageWriter.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual IPackageStoreWriter * AsPackageStoreWriter()

 Downcast function for ICookedPackageWriters that implement the IPackageStoreWriter inherited interface. Serialization/PackageWriter.h  

virtual EPackageWriterResult BeginCacheForCookedPlatformData ( FBeginCacheForCookedPlatformDataInfo& Info
)

   Serialization/PackageWriter.h  

void BeginCook ( const FCookInfo& Info
)

 Signal the start of a cooking pass Serialization/PackageWriter.h  

virtual void CompleteExportsArchiveForDiff ( FPackageInfo& Info,
FLargeMemoryWriter& ExportsArchive
)

 Append all data to the Exports archive that would normally be done in CommitPackage, used for diffing. Serialization/PackageWriter.h  

void EndCook ( const FCookInfo& Info
)

 Signal the end of a cooking pass. Serialization/PackageWriter.h  

void GetBaseGameOplogAttachments ( TArrayView< FName > PackageNames,
TArrayView< FUtf8StringView > AttachmentKeys,
TUniqueFunction< void(FName PackageName, FUtf8StringView AttachmentKey, FCbObject&&Attachment)>&& ...
)

 Read Oplog attachments for the given PackageNames in the BaseGame oplog for the current DLC cook. Serialization/PackageWriter.h  
Report commit status for the given package. Serialization/PackageWriter.h  

virtual FCookCapabilities GetCookCapabilities()

 Return cook capabilities/settings this PackageWriter has/requires Serialization/PackageWriter.h  

FCbObject GetOplogAttachment ( FName PackageName,
FUtf8StringView AttachmentKey
)

 Returns an Attachment that was previously commited for the given PackageName. Serialization/PackageWriter.h  

void GetOplogAttachments ( TArrayView< FName > PackageNames,
TArrayView< FUtf8StringView > AttachmentKeys,
TUniqueFunction< void(FName PackageName, FUtf8StringView AttachmentKey, FCbObject&&Attachment)>&& ...
)

 Callback is called for every cross product pair of PackageNames X AttachmentKeys. Serialization/PackageWriter.h  
Cooked package writers asynchronously hash the chunks for each package after CommitPackage. Serialization/PackageWriter.h  

virtual bool GetPreviousCookedBytes ( const FPackageInfo& Info,
FPreviousCookedBytesData& OutData
)

 Load the bytes of the previously-cooked package, used for diffing Serialization/PackageWriter.h  

virtual FDateTime GetPreviousCookTime()

 Return the timestamp of the previous cook, or FDateTime::MaxValue to indicate previous cook should be assumed newer than any other cook data. Serialization/PackageWriter.h  

void Initialize ( const FCookInfo& Info
)

 Delete outdated cooked data, etc. Serialization/PackageWriter.h  

virtual bool IsAnotherSaveNeeded ( FSavePackageResultStruct& PreviousResult,
FSavePackageArgs& SaveArgs
)

 Report whether an additional save is needed and set up for it if so. Used for diffing. Serialization/PackageWriter.h  

TUniquePtr< FAssetRegistryState > LoadPreviousAssetRegistry ()

 Returns an AssetRegistry describing the previous cook results. Serialization/PackageWriter.h  
Remove all cooked packages from storage. Serialization/PackageWriter.h  

void RemoveCookedPackages ( TArrayView< const FName > PackageNamesToRemove
)

 Remove the given cooked package(s) from storage; they have been modified since the last cook. Serialization/PackageWriter.h  
Called by the Cooker for PackageWriters it is using. Serialization/PackageWriter.h  

bool TryReadMPCookMessageForPackage ( FName PackageName,
FCbObjectView Message
)

 Read PackageData written by WriteMPCookMessageForPackage on a CookWorker. Serialization/PackageWriter.h  

virtual void UpdatePackageModificationStatus ( FName PackageName,
bool bIncrementallyUnmodified,
bool& bInOutShouldIncrementallySkip
)

   Serialization/PackageWriter.h  

virtual void UpdatePackageModifiedStatus ( FUpdatePackageModifiedStatusContext& Context
)

 During incremental cooking, signal the cooked package has been checked for changes, and decide whether it should be incrementally skipped. Serialization/PackageWriter.h  

virtual void UpdateSaveArguments ( FSavePackageArgs& SaveArgs
)

 Modify the SaveArgs if required before the first Save. Used for diffing. Serialization/PackageWriter.h  
Asynchronously create a CompactBinary Object message that replicates all of the package data from package save that is collected in memory and written at end of cook rather than being written to disk during package save. Serialization/PackageWriter.h  

Overridden from IPackageWriter

Name Remarks Include Path Unreal Specifiers

virtual ICookedPackageWriter * AsCookedPackageWriter()

 Downcast function for IPackageWriters that implement the ICookedPackageWriters inherited interface. Serialization/PackageWriter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page