FPackageTrailer | Unreal Engine 5.2 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 FPackageTrailer

Remarks

The package trailer should only ever stored the payloads in the workspace domain. If the package trailer is in the editor domain then it's values should be valid, but when loading non-virtualized payloads they need to come from the workspace domain package.

Constructors

	Type	Name	Description
		FPackageTrailer ()
		FPackageTrailer ( const FPackageTrailer& Other )
		FPackageTrailer ( FPackageTrailer&& Other )

Destructors

	Type	Name	Description
		~FPackageTrailer ()

Functions

Type	Name	Description
int64	FindPayloadOffsetInFile ( const FIoHash& Id )	Returns the absolute offset of the payload in the package file, invalid and virtualized payloads will return INDEX_NONE
int64	FindPayloadSizeOnDisk ( const FIoHash& Id )	Returns the size of the payload on as stored on disk, invalid and virtualized payloads will return INDEX_NONE
EPayloadStatus	FindPayloadStatus ( const FIoHash& Id )	Attempt to find the status of the given payload. EPayloadStatus
void	ForEachPayload ( TFunctionRef< void(const FIoHash&, uint64, uint64, EPayloadAccessMode, UE::Virtualization::EPayload... )	Iterates over all payloads in the trailer and invokes the provoided callback on them
int32	GetNumPayloads ( EPayloadFilter Filter )	Returns the number of payloads that the trailer owns that match the given filter type.
int32	GetNumPayloads ( EPayloadStorageType Type )	Returns the number of payloads that the trailer owns with the given storage type.
FPayloadInfo	GetPayloadInfo ( const FIoHash& Id )
TArray< FIoHash >	GetPayloads ( EPayloadFilter Filter )	Returns an array of the payloads that match the given filter type. EPayloadFilter
TArray< FIoHash >	GetPayloads ( EPayloadStorageType StorageType )	Returns an array of the payloads with the given storage type. EPayloadStoragetype
int64	GetTrailerLength ()	Returns the total size of the of the trailer on disk in bytes
bool	IsValid ()	Returns true if the trailer contains actual data from a package file and false if it just contains the defaults of an unloaded trailer.
FCompressedBuffer	LoadLocalPayload ( const FIoHash& Id, FArchive& Ar )	Loads a payload that is stored locally within the package trailer.
bool	TryLoad ( FArchive& Ar )	Serializes the trailer from the given archive assuming that the seek position of the archive is already at the correct position for the trailer.
bool	TryLoadBackwards ( FArchive& Ar )	Serializes the trailer from the given archive BUT assumes that the seek position of the archive is at the end of the trailer and so will attempt to read the footer first and use that to find the start of the trailer in order to read the header.
bool	TryLoadFromArchive ( FArchive& Ar, FPackageTrailer& OutTrailer )	Try to load a trailer from a given archive. Assumes that the trailer is at the end of the archive
bool	TryLoadFromFile ( const FString& Path, FPackageTrailer& OutTrailer )	Try to load a trailer from a given file path.
bool	TryLoadFromPackage ( const FPackagePath& PackagePath, FPackageTrailer& OutTrailer )	Try to load a trailer from a given package path.
bool	UpdatePayloadAsVirtualized ( const FIoHash& Identifier )	Calling this indicates that the payload has been virtualized and will no longer be stored on disk.