FPakOrderMap

Defines the order mapping for files within a pak.

Windows
MacOS
Linux

References

Module

PakFileUtilities

Header

/Engine/Source/Developer/PakFileUtilities/Public/PakFileUtilities.h

Include

#include "PakFileUtilities.h"

Syntax

class FPakOrderMap

Remarks

Defines the order mapping for files within a pak. When read from the files present in the pak, Indexes will be [0,NumFiles). This is important for detecting gaps in the order between adjacent files in a patch .pak. For new files being added into the pak, the values can be arbitrary, and will be usable only for relative order in an output list. Due to the arbitrary values for new files, the FPakOrderMap can contain files with duplicate Order values.

Constructors

Name Description

Public function

FPakOrderMap()

Functions

Name Description

Public function

void

 

Add

(
    const FString& Filename,
    uint64 Index
)

Add the given filename with the given Sorting Index

Public function

void

 

AddOffset

(
    const FString& Filename,
    uint64 Offset
)

Add the given filename with the given Offset interpreted as Offset in bytes in the Pak File.

Public function

void

 

ConvertOffsetsToOrder()

Remaps all the current values in the OrderMap onto [0, NumEntries).

Public function

void

 

Empty()

Public function Const

uint64

 

GetFileOrder

(
    const FString& Path,
    bool bAllowUexpUBulkFallback,
    bool* OutIsPrimary
)

Public function Const

int32

 

Num()

Public function

bool

 

ProcessOrderFile

(
    const TCHAR* ResponseFile,
    bool bSecondaryOrderFile,
    bool bMergeOrder
)

Public function

void

 

WriteOpenOrder

(
    FArchive* Ar
)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss