Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc
Inheritance Hierarchy
- FArchiveState
- FArchive
- FPreloadableArchive
- FPreloadableFile
References
| Module | Core |
| Header | /Engine/Source/Runtime/Core/Public/Misc/PreloadableFile.h |
| Include | #include "Misc/PreloadableFile.h" |
Syntax
class FPreloadableFile : public FPreloadableArchive
Remarks
An FPreloadableArchive that is customized for reading files from IFileManager.
This class also supports registration of instances of this class by filename, which other systems in the engine can use to request an FArchive for the preload file, if it exists, replacing a call they would otherwise make to IFileManager::Get().CreateFileReader.
As with the base class, the preloading can work in either PreloadBytes or PreloadHandle mode.
Activate PreloadBytes mode by passing Flags::PreloadBytes to InitializeAsync. Activate PreloadHandle mode by passing Flags::PreloadHandle to InitializeAsync, optionally or'd with Flags::Prime.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FPreloadableFile
(
FStringView FileName |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | InitializeAsync
(
uint32 InFlags, |
Initialize the FPreloadableFile asynchronously, performing FileOpen operations on another thread. |
  |
bool | TryRegister
(
const TSharedPtr< FPreloadableFile >& PreloadableFile |
Registration. |
  |
FArchive * | TryTakeArchive
(
const TCHAR* FileName |
Look up an FPreloadableFile instance registered for the given FileName, and return an FArchive from it. |
  |
bool | UnRegister
(
const TSharedPtr< FPreloadableFile >& PreloadableFile |
Remove the FPreloadableFile instance if it is registered for its FileName. |
Constants
| Name | Description |
|---|---|
| RegisteredFiles | Map used for TryTakeArchive registration. |