FPakInfo Struct Reference

#include <IPlatformFilePak.h>

Public Types
enum	{ PakFile_Magic = 0x5A6F12E1 , MaxChunkDataSize = 64*1024 , CompressionMethodNameLen = 32 , MaxNumCompressionMethods =5 }
enum	{   PakFile_Version_Initial = 1 , PakFile_Version_NoTimestamps = 2 , PakFile_Version_CompressionEncryption = 3 , PakFile_Version_IndexEncryption = 4 ,   PakFile_Version_RelativeChunkOffsets = 5 , PakFile_Version_DeleteRecords = 6 , PakFile_Version_EncryptionKeyGuid = 7 , PakFile_Version_FNameBasedCompressionMethod = 8 ,   PakFile_Version_FrozenIndex = 9 , PakFile_Version_PathHashIndex = 10 , PakFile_Version_Fnv64BugFix = 11 , PakFile_Version_Utf8PakDirectory = 12 ,   PakFile_Version_Last , PakFile_Version_Invalid , PakFile_Version_Latest = PakFile_Version_Last - 1 }

Public Member Functions
	FPakInfo ()
int64	GetSerializedSize (int32 InVersion=PakFile_Version_Latest) const
int64	HasRelativeCompressedChunkOffsets () const
void	Serialize (FArchive &Ar, int32 InVersion)
int32	GetCompressionMethodIndex (FName CompressionMethod)
FName	GetCompressionMethod (uint32 Index) const
TOptional< FName >	TryGetCompressionMethod (uint32 Index) const

Public Attributes
uint32	Magic
int32	Version
int64	IndexOffset
int64	IndexSize
FSHAHash	IndexHash
uint8	bEncryptedIndex
FGuid	EncryptionKeyGuid
TArray< FName >	CompressionMethods

Detailed Description

Struct which holds pak file info (version, index offset, hash value).

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
PakFile_Magic	Magic number to use in header
MaxChunkDataSize	Size of cached data.
CompressionMethodNameLen	Length of a compression format name
MaxNumCompressionMethods	Number of allowed different methods

anonymous enum

anonymous enum

Version numbers.

Enumerator
PakFile_Version_Initial
PakFile_Version_NoTimestamps
PakFile_Version_CompressionEncryption
PakFile_Version_IndexEncryption
PakFile_Version_RelativeChunkOffsets
PakFile_Version_DeleteRecords
PakFile_Version_EncryptionKeyGuid
PakFile_Version_FNameBasedCompressionMethod
PakFile_Version_FrozenIndex
PakFile_Version_PathHashIndex
PakFile_Version_Fnv64BugFix
PakFile_Version_Utf8PakDirectory
PakFile_Version_Last
PakFile_Version_Invalid
PakFile_Version_Latest

Constructor & Destructor Documentation

FPakInfo()

FPakInfo::FPakInfo ( )

inline

Constructor.

Member Function Documentation

GetCompressionMethod()

FName FPakInfo::GetCompressionMethod ( uint32  Index ) const

inline

GetCompressionMethodIndex()

int32 FPakInfo::GetCompressionMethodIndex ( FName  CompressionMethod )

inline

GetSerializedSize()

int64 FPakInfo::GetSerializedSize ( int32  InVersion = PakFile_Version_Latest ) const

inline

Gets the size of data serialized by this struct.

Returns

Serialized data size.

HasRelativeCompressedChunkOffsets()

int64 FPakInfo::HasRelativeCompressedChunkOffsets ( ) const

inline

Serialize()

void FPakInfo::Serialize ( FArchive &  Ar, int32  InVersion  )

inline

Serializes this struct.

Parameters

Ar	Archive to serialize data with.

TryGetCompressionMethod()

TOptional< FName > FPakInfo::TryGetCompressionMethod ( uint32  Index ) const

inline

Member Data Documentation

bEncryptedIndex

uint8 FPakInfo::bEncryptedIndex

Flag indicating if the pak index has been encrypted.

CompressionMethods

TArray<FName> FPakInfo::CompressionMethods

Compression methods used in this pak file (FNames, saved as FStrings)

EncryptionKeyGuid

FGuid FPakInfo::EncryptionKeyGuid

Encryption key guid. Empty if we should use the embedded key.

IndexHash

FSHAHash FPakInfo::IndexHash

SHA1 of the bytes in the index, used to check for data corruption when loading the index.

IndexOffset

int64 FPakInfo::IndexOffset

Offset to pak file index.

IndexSize

int64 FPakInfo::IndexSize

Size (in bytes) of pak file index.

Magic

uint32 FPakInfo::Magic

Pak file magic value.

Version

int32 FPakInfo::Version

Pak file version.

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/PakFile/Public/IPlatformFilePak.h