| IPlatformFile
|
Module |
|
Header |
/Engine/Source/Runtime/PakFile/Public/IPlatformFilePak.h |
Include |
#include "IPlatformFilePak.h" |
class FPakPlatformFile : public IPlatformFile
Platform file wrapper to be able to use pak files.
Name | Description | |
---|---|---|
|
FPakPlatformFile() |
Constructor. |
Name | Description | |
---|---|---|
|
~FPakPlatformFile() |
Destructor. |
Name | Description | ||
---|---|---|---|
|
AnyChunksAvailable() |
Returns true if any of the mounted or pending pak files are chunks (filenames starting pakchunkN) |
|
|
BroadcastPakChunkSignatureCheckFailure ( |
Broadacast a signature check failure through any registered delegates in a thread safe way. |
|
|
BroadcastPakMasterSignatureTableCheckFailure ( |
Broadacast a master signature table failure through any registered delegates in a thread safe way. |
|
|
CheckIfPakFilesExist ( |
Checks if pak files exist in any of the known pak file locations. |
|
|
ConvertToPakRelativePath |
Converts a filename to a path inside pak file. |
|
|
FindFileInPakFiles ( |
Finds a file in all available pak files. |
|
|
FindFileInPakFiles |
Overload needed for deprecation; remove this when removing the version with a FPakFile** OutPakFile |
|
|
FindFileInPakFiles ( |
Finds a file in the specified pak files. |
|
|
FindFileInPakFiles |
Overload needed for deprecation; remove this when removing the version with a FPakFile** OutPakFile |
|
|
FindFilesInternal |
||
|
FFilenameSec... |
GetFilenameSecurityDelegate() |
Access static delegate for loose file security. |
|
GetFilenamesFromIostoreByBlockIndex |
Returns the RelativePathFromMount Filename for every Filename found in the Iostore Container that relates to the provided block indexes |
|
|
GetFilenamesFromIostoreContainer |
Returns the RelativePathFromMount Filename for every file found in the given Iostore Container |
|
|
GetMountedPakFilenames |
Get a list of all pak files which have been successfully mounted |
|
|
const TCHAR ... |
GetMountStartupPaksWildCard() |
Get the wild card pattern used to identify paks to load on startup |
|
EChunkLocati... |
GetPakChunkLocation ( |
Determine location information for a given pakchunk index. |
|
FPakCustomEn... |
GetPakCustomEncryptionDelegate() |
Access static delegate for custom encryption. |
|
GetPakEncryptionKey ( |
Helper function for accessing pak encryption key Precaching |
|
|
GetPakFolders |
Gets all pak file locations. |
|
|
FPakSetIndex... |
GetPakSetIndexSettingsDelegate() |
Access static delegate for setting PakIndex settings. |
|
TSharedPtr< ... |
GetPakSignatureFile ( |
Load a pak signature file. |
|
FPakSigningF... |
GetPakSigningFailureHandlerData() |
Access static delegate for handling a pak signature check failure. |
|
GetPrunedFilenamesInChunk |
Get a list of RelativePathFromMount for every file in the given Pak that lives in any of the given chunks. |
|
|
GetPrunedFilenamesInPakFile |
Gets a list of FullPaths (includes Mount directory) for every File in the given Pak's Pruned DirectoryIndex |
|
|
const TCHAR ... |
GetTypeName() |
Get the unique name for the pak platform file layer |
|
HandleMountCommand ( |
||
|
HandlePakCorruptCommand ( |
||
|
HandlePakListCommand ( |
BEGIN Console commands. |
|
|
HandleReloadPakReadersCommand ( |
||
|
HandleUnmountCommand ( |
||
|
IterateDirectoryInternal |
||
|
IterateDirectoryInternal ( |
||
|
IterateDirectoryStatInternal ( |
||
|
Mount |
Mounts a pak file at the specified path. |
|
|
MountAllPakFiles |
||
|
MountAllPakFiles |
||
|
OptimizeMemoryUsageForMountedPaks() |
||
|
ReloadPakReaders() |
Re-creates all the pak readers |
|
|
RemoveCachedPakSignaturesFile ( |
Remove the intenrally cached pointer to the signature file for the specified pak |
|
|
SetMountStartupPaksWildCard ( |
Overrides the wildcard used for searching paks. Call before initialization |
|
|
Unmount ( |
Name | Description | ||
---|---|---|---|
|
ConvertToAbsolutePathForExternalAppForRead ( |
Converts passed in filename to use an absolute path (for reading). |
|
|
ConvertToAbsolutePathForExternalAppForWrite ( |
Converts passed in filename to use an absolute path (for writing) |
|
|
CopyFile ( |
Copy a file. This will fail if the destination file already exists. |
|
|
CreateDirectory ( |
Create a directory and return true if the directory was created or already existed. |
|
|
CreateDirectoryTree ( |
Create a directory, including any parent directories and return true if the directory was created or already existed. |
|
|
DeleteDirectory ( |
Delete a directory and return true if the directory was deleted or otherwise does not exist. |
|
|
DeleteDirectoryRecursively ( |
Delete all files and subdirectories in a directory, then delete the directory itself |
|
|
DeleteFile ( |
Delete a file and return true if the file exists. Will not delete read only files. |
|
|
DirectoryExists ( |
Return true if the directory exists. |
|
|
FileExists ( |
Return true if the file exists. |
|
|
FileSize ( |
Return the size of the file, or -1 if it doesn't exist. |
|
|
FindFiles |
Finds all the files within the given directory, with optional file extension filter |
|
|
FindFilesRecursively |
Finds all the files within the directory tree, with optional file extension filter |
|
|
GetAccessTimeStamp ( |
Return the last access time of a file. |
|
|
GetFilenameOnDisk ( |
For case insensitive filesystems, returns the full path of the file with the same case as in the filesystem |
|
|
IPlatformFil... |
GetLowerLevel() |
Gets the platform file wrapped by this file. |
|
const TCHAR ... |
GetName() |
Gets this platform file type name. |
|
FFileStatDat... |
GetStatData ( |
Return the stat data for the given file or directory. |
|
GetTimeStamp ( |
Return the modification time of a file. |
|
|
GetTimeStampPair |
||
|
Initialize ( |
Initializes platform file. |
|
|
InitializeNewAsyncIO() |
Performs initialization of the platform file after the new async IO has been enabled |
|
|
IsReadOnly ( |
Return true if the file is read only. |
|
|
IterateDirectory ( |
Call the Visit function of the visitor once for each file or directory in a single directory. |
|
|
IterateDirectoryRecursively ( |
Call the Visit function of the visitor once for each file or directory in a directory tree. |
|
|
IterateDirectoryStat ( |
Call the Visit function of the visitor once for each file or directory in a single directory. |
|
|
IterateDirectoryStatRecursively ( |
Call the Visit function of the visitor once for each file or directory in a directory tree. |
|
|
MakeUniquePakFilesForTheseFiles |
Make unique in memory pak files from a list of named files |
|
|
MoveFile |
Attempt to move a file. Return true if successful. Will not overwrite existing files. |
|
|
IAsyncReadFi... |
OpenAsyncRead ( |
Open a file for async reading. This call does not hit the disk or block. |
|
IMappedFileH... |
OpenMapped ( |
Open a file for async reading. This call does hit the disk; it is synchronous open. |
|
IFileHandle ... |
OpenRead |
Attempt to open a file for reading. |
|
IFileHandle ... |
OpenWrite |
Attempt to open a file for writing. |
|
SetAsyncMinimumPriority ( |
Controls if the pak precacher should process precache requests. |
|
|
SetLowerLevel ( |
Sets the platform file wrapped by this file. |
|
|
SetReadOnly |
Attempt to change the read only status of a file. Return true if successful. |
|
|
SetTimeStamp |
Sets the modification time of a file |
|
|
ShouldBeUsed ( |
Checks if this platform file should be used even though it was not asked to be. |
|
|
Tick() |
Platform file can override this to get a regular tick from the engine |
Name |
Description |
|
---|---|---|
|
FPakSigningFailureHandlerData |
|
|
FPreventDuplicatesStatVisitor |
|
|
FPreventDuplicatesVisitor |
|
|
FPreventDuplicatesVisitorBase |
Helper class to filter out files which have already been visited in one of the pak files. |
Name |
Description |
---|---|
PakSignatureFileCache |
Internal cache of pak signature files. |
PakSignatureFileCacheLock |
Name | Description | ||
---|---|---|---|
|
FindFileInPakFiles |
Use version with OutPakFile is a TRefCountPtr |
|
|
FindFileInPakFiles |
Use version with OutPakFile is a TRefCountPtr |
|
|
GetFilenamesInChunk |
Use GetPrunedFilenamesInChunk |
|
|
GetFilenamesInPakFile |
Use GetPrunedFilenamesInPakFile |
|
|
FPakChunkSig... |
GetPakChunkSignatureCheckFailedHandler() |
GetPakChunkSignatureCheckFailedHandler is not thread safe, so please migrate to using GetPakSigningFailureHandlerData and locking the critical section around any use of the delegates |
|
FPakMasterSi... |
GetPakMasterSignatureTableCheckFailureHandler() |
GetPakMasterSignatureTableCheckFailureHandler is not thread safe, so please migrate to using GetPakSigningFailureHandlerData and locking the critical section around any use of the delegates |