IPackageWriter

Interface for SavePackage to write packages to storage.

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 IPackageWriter

Remarks

Interface for SavePackage to write packages to storage.

Destructors

Name Description

Public function Virtual

~IPackageWriter()

Functions

Name Description

Public function Virtual

void

 

AddToExportsSize

(
    int64& InOutExportsSize
)

Increase the referenced ExportsSize by the size in bytes of the data that will be added on to it during commit before writing to disk.

Public function Virtual

ICookedPacka...

 

AsCookedPackageWriter()

Downcast function for IPackageWriters that implement the ICookedPackageWriters inherited interface.

Public function

void

 

BeginPackage

(
    const FBeginPackageInfo& Info
)

Mark the beginning of a package store transaction for the specified package

Public function

TFuture< FMD...

 

CommitPackage

(
    FCommitPackageInfo&& Info
)

Finalize a package started with BeginPackage()

Public function Virtual

TUniquePtr< ...

 

CreateLinkerArchive

(
    FName PackageName,
    UObject* Asset
)

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

Public function Virtual Const

FCapabilitie...

 

GetCapabilities()

Return capabilities/settings this PackageWriter has/requires

Public function Virtual Const

bool

 

IsPreSaveCompleted()

Report whether PreSave was already called by the PackageWriter before the current UPackage::Save call.

Public function

void

 

WriteAdditionalFile

(
    const FAdditionalFileInfo& Info,
    const FIoBuffer& FileData
)

Write separate files written by UObjects during cooking via UObject::CookAdditionalFiles.

Public function

void

 

WriteBulkData

(
    const FBulkDataInfo& Info,
    const FIoBuffer& BulkData,
    const TArray< FFileRegion >& FileR...
)

Write bulk data for the current package

Public function

void

 

WriteLinkerAdditionalData

(
    const FLinkerAdditionalDataInfo& I...,
    const FIoBuffer& Data,
    const TArray< FFileRegion >& FileR...
)

Write separate data written by UObjects via FLinkerSave::AdditionalDataToAppend.

Public function

void

 

WritePackageData

(
    const FPackageInfo& Info,
    FLargeMemoryWriter& ExportsArchive,
    const TArray< FFileRegion >& FileR...
)

Write package data (exports and serialized header)

Classes

Enums

Name

Description

Public enum

EWriteOptions