FPackageTrailer

The package trailer should only ever stored the payloads in the workspace domain.

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public function

FPackageTrailer()

Public function

FPackageTrailer

(
    const FPackageTrailer& Other
)

Public function

FPackageTrailer

(
    FPackageTrailer&& Other
)

Destructors

Name Description

Public function

~FPackageTrailer()

Functions

Name Description

Public function Const

int64

 

FindPayloadOffsetInFile

(
    const Virtualization::FPayloadId& ...
)

Returns the absolute offset of the payload in the package file, invalid and virtualized payloads will return INDEX_NONE

Public function Const

EPayloadStat...

 

FindPayloadStatus

(
    const Virtualization::FPayloadId& ...
)

Attempt to find the status of the given payload. EPayloadStatus

Public function Const

int32

 

GetNumPayloads

(
    EPayloadFilter Type
)

Returns the number of payloads that the trailer owns that match the given filter type.

Public function Const

TArray< Virt...

 

GetPayloads

(
    EPayloadFilter Type
)

Returns an array of the payloads that match the given filter type. EPayloadType

Public function Const

int64

 

GetTrailerLength()

Returns the total size of the of the trailer on disk in bytes

Public function Static

bool

 

IsEnabled()

Returns if the feature is enabled or disabled.

Public function Const

FCompressedB...

 

LoadLocalPayload

(
    const Virtualization::FPayloadId& ...,
    FArchive& Ar
)

Loads a payload that is stored locally within the package trailer.

Public function

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.

Public function

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.

Public function Static

bool

 

TryLoadFromPackage

(
    const FPackagePath& PackagePath,
    FPackageTrailer& OutTrailer
)

Try to load a trailer from a given package path.

Public function

bool

 

UpdatePayloadAsVirtualized

(
    const Virtualization::FPayloadId& ...
)

Calling this indicates that the payload has been virtualized and will no longer be stored on disk.

Operators

Name Description

Public function

FPackageTrai...

 

operator=

(
    FPackageTrailer&& Other
)

Public function

FPackageTrai...

 

operator=

(
    const FPackageTrailer& Other
)

Classes

Name

Description

Public struct

FFooter

Public struct

FHeader