Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > PakFile > FPakFile

Light Theme

Dark Theme

FPakFile

Pak file.

Windows

MacOS

Linux

Inheritance Hierarchy

FNoncopyable

FPakFile

References

Module	PakFile
Header	/Engine/Source/Runtime/PakFile/Public/IPlatformFilePak.h
Include	#include "IPlatformFilePak.h"

Syntax

class FPakFile : private FNoncopyable

Remarks

Pak file.

Constructors

	Name	Description
	FPakFile ( FArchive* Archive )	Creates a pak file using the supplied archive.
	FPakFile ( IPlatformFile* LowerLevel, const TCHAR* Filename, bool bIsSigned, bool bLoadIndex )	Creates a pak file using the supplied file handle.

Destructors

	Name	Description
	~FPakFile()

Functions

	Name	Description
bool	Check()	Checks the validity of the pak data by reading out the data for every file in the pak
bool	DirectoryExists ( const TCHAR* InPath )	Checks if a directory exists in pak file.
EFindResult	Find ( const FString& Filename, FPakEntry* OutEntry )
const FPakDi...	FindDirectory ( const TCHAR* InPath )	Finds a directory in pak file.
void	FindFilesAtPath ( ContainerType& OutFiles, const TCHAR* InPath, bool bIncludeFiles, bool bIncludeDirectories, bool bRecursive )	Looks for files or directories within the pak file.
int32	GetCacheIndex()
ECacheType	GetCacheType()
const FStrin...	GetFilename()	Gets pak filename.
FName	GetFilenameName()
void	GetFilenames ( TArray< FString >& OutFileList )
void	GetFilenamesInChunk ( const TArray< int32 >& InChunkIDs, TArray< FString >& OutFileList )
const TMemor...	GetIndex()	Gets pak file index.
const FPakIn...	GetInfo()	Gets this pak file info.
const FStrin...	GetMountPoint()	Gets pak file mount point.
int32	GetNumFiles()	Gets the number of files in this pak.
FArchive ...	GetSharedReader ( IPlatformFile* LowerLevel )	Gets shared pak file archive for given thread.
const FDateT...	GetTimestamp()	Gets this pak file's tiemstamp.
bool	GetUnderlyingCacheTrimDisabled()
bool	HasFilenames()	Returns whether the pak filenames are still resident in memory.
bool	HasShrunkPakEntries()	Returns whether the pak files list has been shrunk or not
bool	IsValid()	Checks if the pak file is valid.
void	MakeDirectoryFromPath ( FString& Path )	Helper function to append '/' at the end of path.
bool	PassedSignatureChecks()	Checks if the pak has valid chunk signature checking data, and that the data passed the initial signing check
void	SetCacheIndex ( int32 InCacheIndex )
void	SetCacheType ( ECacheType InCacheType )
void	SetMountPoint ( const TCHAR* Path )	Sets the pak file mount point.
void	SetUnderlyingCacheTrimDisabled ( bool InUnderlyingCacheTrimDisabled )
bool	ShrinkPakEntriesMemoryUsage()	Lower memory usage by bit-encoding the pak file entry information.
int64	TotalSize()
bool	UnloadPakEntryFilenames ( TMap< uint64, FPakEntry >& CrossPa..., TArray< FString >* DirectoryRo..., bool bAllowRetries )	Saves memory by hashing the filenames, if possible.

Classes

	Name	Description
	FFileIterator	Iterator class used to iterate over all files in pak.

Enums

	Name	Description
	ECacheType	Pak files can share a cache or have their own
	EFindResult	Finds an entry in the pak file matching the given filename.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss