ICookedPackageWriter

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

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public function Virtual

~ICookedPackageWriter()

Functions

Name Description

Public function Virtual

IPackageStor...

 

AsPackageStoreWriter()

Downcast function for ICookedPackageWriters that implement the IPackageStoreWriter inherited interface.

Public function

void

 

BeginCook()

Signal the start of a cooking pass

Public function Virtual

void

 

CompleteExportsArchiveForDiff

(
    const FPackageInfo& Info,
    FLargeMemoryWriter& ExportsArchive
)

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

Public function

void

 

EndCook()

Signal the end of a cooking pass.

Public function

void

 

Flush()

Flush any outstanding writes.

Public function Virtual Const

FCookCapabil...

 

GetCookCapabilities()

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 Virtual

bool

 

GetPreviousCookedBytes

(
    const FPackageInfo& Info,
    FPreviousCookedBytesData& OutData
)

Load the bytes of the previously-cooked package, used for diffing

Public function Virtual Const

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.

Public function

void

 

Initialize

(
    const FCookInfo& Info
)

Delete outdated cooked data, etc.

Public function Virtual

bool

 

IsAnotherSaveNeeded

(
    FSavePackageResultStruct& Previous...,
    FSavePackageArgs& SaveArgs
)

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

Public function

TUniquePtr< ...

 

LoadPreviousAssetRegistry()

Returns an AssetRegistry describing the previous cook results.

Public function

void

 

MarkPackagesUpToDate

(
    TArrayView< const FName > UpToDateP...
)

Signal the given cooked package(s) have been checked for changes and have not been modified since the last cook.

Public function

void

 

RemoveCookedPackages()

Remove all cooked packages from storage.

Public function

void

 

RemoveCookedPackages

(
    TArrayView< const FName > PackageNa...
)

Remove the given cooked package(s) from storage; they have been modified since the last cook.

Public function Virtual

void

 

UpdateSaveArguments

(
    FSavePackageArgs& SaveArgs
)

Modify the SaveArgs if required before the first Save. Used for diffing.

Overridden from IPackageWriter

Name Description

Public function Virtual

ICookedPacka...

 

AsCookedPackageWriter()

Downcast function for IPackageWriters that implement the ICookedPackageWriters inherited interface.

Classes