Navigation
API > API/Runtime > API/Runtime/Core
Interface for SavePackage to write packages to storage.
| Name | IPackageWriter |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Serialization/PackageWriter.h |
| Include Path | #include "Serialization/PackageWriter.h" |
Syntax
class IPackageWriter
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IPackageWriter() |
Serialization/PackageWriter.h |
Structs
| Name | Remarks |
|---|---|
| FAdditionalFileInfo | |
| FBeginPackageInfo | Events the PackageWriter receives. |
| FBulkDataInfo | |
| FCapabilities | |
| FCommitAttachmentInfo | |
| FCommitPackageInfo | |
| FLinkerAdditionalDataInfo | |
| FPackageInfo | |
| FPackageTrailerInfo |
Enums
Public
| Name | Remarks |
|---|---|
| ECommitStatus | |
| EWriteOptions |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ICookedPackageWriter * AsCookedPackageWriter() |
Downcast function for IPackageWriters that implement the ICookedPackageWriters inherited interface. | Serialization/PackageWriter.h | |
void BeginPackage
(
const FBeginPackageInfo& Info |
Mark the beginning of a package store transaction for the specified package | Serialization/PackageWriter.h | |
void CommitPackage
(
FCommitPackageInfo&& Info |
Finalize a package started with BeginPackage() | Serialization/PackageWriter.h | |
TUniquePtr< FLargeMemoryWriter > CreateLinkerArchive
(
FName PackageName, |
Create the FLargeMemoryWriter to which the Header and Exports are written during the save. | Serialization/PackageWriter.h | |
TUniquePtr< FLargeMemoryWriter > CreateLinkerExportsArchive
(
FName PackageName, |
Returns an archive to be used when serializing exports. | Serialization/PackageWriter.h | |
virtual FCapabilities GetCapabilities() |
Return capabilities/settings this PackageWriter has/requires | Serialization/PackageWriter.h | |
virtual int64 GetExportsFooterSize() |
Report the size of the Footer that is added after Exports and BulkData but before the PackageTrailer | Serialization/PackageWriter.h | |
virtual bool IsPreSaveCompleted() |
Report whether PreSave was already called by the PackageWriter before the current UPackage::Save call. | Serialization/PackageWriter.h | |
virtual void RegisterDeterminismHelper
(
UObject* SourceObject, |
Overridden by PackageWriters that handle bDeterminismDebug=true. | Serialization/PackageWriter.h | |
void WriteAdditionalFile
(
const FAdditionalFileInfo& Info, |
Write separate files written by UObjects during cooking via UObject::CookAdditionalFiles. | Serialization/PackageWriter.h | |
void WriteBulkData
(
const FBulkDataInfo& Info, |
Write bulk data for the current package | Serialization/PackageWriter.h | |
void WriteLinkerAdditionalData
(
const FLinkerAdditionalDataInfo& Info, |
Write separate data written by UObjects via FLinkerSave::AdditionalDataToAppend. | Serialization/PackageWriter.h | |
void WritePackageData
(
const FPackageInfo& Info, |
Write package data (exports and serialized header) | Serialization/PackageWriter.h | |
void WritePackageTrailer
(
const FPackageTrailerInfo& Info, |
Write the PackageTrailer, a separate segment for some bulkdata that is written the end of the file. | Serialization/PackageWriter.h |