FPackageTrailerBuilder | Unreal Engine 5.4 Documentation

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/UObject

References


Module	CoreUObject
Header	/Engine/Source/Runtime/CoreUObject/Public/UObject/PackageTrailer.h
Include	#include "UObject/PackageTrailer.h"

Syntax

class FPackageTrailerBuilder

Remarks

This class is used to build a FPackageTrailer and write it disk.

While saving a package, payloads should be added to a FPackageTrailer via AddPayload then once the package has been saved to disk BuildAndAppendTrailer should be called.

Constructors

	Type	Name	Description
		FPackageTrailerBuilder ()
		FPackageTrailerBuilder ( const FName& InPackageName )
		FPackageTrailerBuilder ( FString&& DebugContext )

Destructors

	Type	Name	Description
		~FPackageTrailerBuilder ()

Functions

Type	Name	Description
void	AddPayload ( const FIoHash& Identifier, FCompressedBuffer Payload, UE::Virtualization::EPayloadFilterReason Filter, AdditionalDataCallback&& Callback )	Adds a payload to the builder to be written to the trailer.
void	AddPayload ( const FIoHash& Identifier, FCompressedBuffer Payload, UE::Virtualization::EPayloadFilterReason Filter )
void	AddVirtualizedPayload ( const FIoHash& Identifier, int64 RawSize )	Adds an already virtualized payload to the builder to be written to the trailer.
bool	BuildAndAppendTrailer ( FLinkerSave* Linker, FArchive& DataArchive, int64& InOutPackageFileOffset )
bool	BuildAndAppendTrailer ( FLinkerSave* Linker, FArchive& DataArchive )
uint64	CalculateTrailerLength ()	Returns the length of the trailer (in bytes) that the builder would currently create.
FPackageTrailerBuilder	CreateFromTrailer ( const FPackageTrailer& Trailer, FArchive& Ar, const FName& PackageName )
FPackageTrailerBuilder	CreateFromTrailer ( const FPackageTrailer& Trailer, FArchive& Ar, FString DebugContext )	Creates a builder from a pre-existing FPackageTrailer.
TUniquePtr< UE::FPackageTrailerBuilder >	CreateReferenceToTrailer ( const FPackageTrailer& Trailer, const FName& PackageName )
TUniquePtr< UE::FPackageTrailerBuilder >	CreateReferenceToTrailer ( const FPackageTrailer& Trailer, FString DebugContext )	Creates a builder from a pre-existing FPackageTrailer that will will reference the local payloads of the source trailer.
const FString &	GetDebugContext ()	Returns the debug context associated with the builder, used for adding further description to error messages
int32	GetNumLocalPayloads ()	Returns the number of payload entries in the builder with the access mode EPayloadAccessMode::Local
int32	GetNumPayloads ()	Returns the total number of payload entries in the builder
int32	GetNumReferencedPayloads ()	Returns the number of payload entries in the builder with the access mode EPayloadAccessMode::Referenced
int32	GetNumVirtualizedPayloads ()	Returns the number of payload entries in the builder with the access mode EPayloadAccessMode::Virtualized
bool	IsEmpty ()	Returns if the builder has any payload entries or not
bool	IsLocalPayloadEntry ( const FIoHash& Identifier )
bool	IsReferencedPayloadEntry ( const FIoHash& Identifier )
bool	IsVirtualizedPayloadEntry ( const FIoHash& Identifier )
bool	UpdatePayloadAsLocal ( const FIoHash& Identifier, FCompressedBuffer Payload )	Allows the caller to replace a payload in the builder that is already marked as virtualized and replace it with one that will be stored locally.

Typedefs

Name	Description
AdditionalDataCallback

Navigation