Navigation
API > API/Developer > API/Developer/DirectoryWatcher
Configuration structure required to construct a FFileCache
| Name | FFileCacheConfig |
| Type | struct |
| Header File | /Engine/Source/Developer/DirectoryWatcher/Public/FileCache.h |
| Include Path | #include "FileCache.h" |
Syntax
struct FFileCacheConfig
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FFileCacheConfig
(
FString InDirectory, |
FileCache.h |
Enums
Public
| Name | Remarks |
|---|---|
| EChangeDetection | Enum that specifies what changes are required for a change to be reported. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDetectChangesSinceLastRun | bool | When true, changes to the directory since the cache shutdown will be detected and reported. | FileCache.h | |
| CacheFile | FString | String specifying the file that the cache should be saved to. | FileCache.h | |
| CustomChangeLogic | TFunction< TOptional< bool >(const FImmutableString &, const FFileData &)> | User-specified custom change detection logic. | FileCache.h | |
| Directory | FString | String specifying the directory on disk that the cache should reflect | FileCache.h | |
| PathType | EPathType | Path type to return, relative to the directory or absolute. | FileCache.h | |
| Rules | FMatchRules | List of rules which define what we will be watching | FileCache.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDetectMoves | bool | True to detect moves and renames (based on file hash), false otherwise. Implies bRequireFileHashes. | FileCache.h | |
| bRequireFileHashes | bool | When true, the cache will also calculate MD5 hashes for files. | FileCache.h | |
| ChangeDetectionBits | TBitArray | Bitfied specifying how we will be detecting changes. See EChangeDetection. | FileCache.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FFileCacheConfig & DetectChangesFor
(
EChangeDetection ChangeType, |
Instruct the cache to report the specified changes to files | FileCache.h | |
FFileCacheConfig & DetectMoves
(
bool bInDetectMoves |
Set up this cache to detect moves | FileCache.h | |
FFileCacheConfig & RequireFileHashes
(
bool bInRequireFileHashes |
Set up this cache to generate MD5 hashes for its constituent files | FileCache.h |