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 > API/Runtime/Core/Serialization

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Serialization/PackageWriter.h
Include #include "Serialization/PackageWriter.h"

Syntax

class ICookedPackageWriter : public IPackageWriter

Remarks

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

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual IPackageStoreWriter * Downcast function for ICookedPackageWriters that implement the IPackageStoreWriter inherited interface.
Public function Virtual EPackageWriterResult  
Public function void

BeginCook ( const FCookInfo& Info
)

 Signal the start of a cooking pass
Public function Virtual void Append all data to the Exports archive that would normally be done in CommitPackage, used for diffing.
Public function void

EndCook ( const FCookInfo& Info
)

 Signal the end of a cooking pass.
Public function Virtual Const FCookCapabilities Return cook capabilities/settings this PackageWriter has/requires
Public function FCbObject

GetOplogAttachment ( FName PackageName,
FUtf8StringView AttachmentKey
)

 Returns an Attachment that was previously commited for the given PackageName.
Public function TMap< FName, TRefCountPtr< FPackageHashes > > & Cooked package writers asynchronously hash the chunks for each package after CommitPackage.
Public function Virtual bool Load the bytes of the previously-cooked package, used for diffing
Public function Virtual Const FDateTime Return the timestamp of the previous cook, or FDateTime::MaxValue to indicate previous cook should be assumed newer than any other cook data.
Public function void

Initialize ( const FCookInfo& Info
)

 Delete outdated cooked data, etc.
Public function Virtual bool Report whether an additional save is needed and set up for it if so. Used for diffing.
Public function TUniquePtr< FAssetRegistryState > Returns an AssetRegistry describing the previous cook results.
Public function void

MarkPackagesUpToDate ( TArrayView< const FName > UpToDatePackages
)

 Signal the given cooked package(s) have been checked for changes and have not been modified since the last cook.
Public function void Remove all cooked packages from storage.
Public function void

RemoveCookedPackages ( TArrayView< const FName > PackageNamesToRemove
)

 Remove the given cooked package(s) from storage; they have been modified since the last cook.
Public function bool Read PackageData written by WriteMPCookMessageForPackage on a CookWorker.
Public function Virtual void Modify the SaveArgs if required before the first Save. Used for diffing.
Public function TFuture< FCbObject > 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.

Overridden from IPackageWriter

  Type Name Description
Public function Virtual ICookedPackageWriter * Downcast function for IPackageWriters that implement the ICookedPackageWriters inherited interface.

Classes

  Type Name Description
Public struct FBeginCacheForCookedPlatformDataInfo    
Public struct FCookCapabilities    
Public struct FCookInfo    
Public struct FPreviousCookedBytesData    

Enums

  Type Name Description
Public enum EPackageHeaderFormat    

Typedefs

Name Description
FBeginCacheCallback Helper callback type for Writers that need to send the message on to UCookOnTheFlyServer.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page