Navigation
API > API/Plugins > API/Plugins/FileSandboxCore
Manages the file sandbox.
While this is alive, some engine I/O operations are sandboxed. Only files in mount points (game content, engine content, plugin content) are tracked. Other files, such as those residing in Saved/ or Config/ are not affected.
| Name | ISandboxInstance |
| Type | class |
| Header File | /Engine/Plugins/Developer/Sandbox/FileSandbox/Source/FileSandboxCore/Public/ISandboxInstance.h |
| Include Path | #include "ISandboxInstance.h" |
Syntax
class ISandboxInstance
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISandboxInstance() |
ISandboxInstance.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool DeletedPackageExistsInNonSandbox
(
const FString& InFilename |
ISandboxInstance.h | ||
void EnumerateFileChanges
(
TFunctionRef< FProcessFileChangeSignature > InProcess, |
Invokes InProcess for every effective file change that would be performed if the sandbox was persisted. | ISandboxInstance.h | |
FGatheredFileChanges GatherChangedFiles
(
EFileChangeGatherFlags InFlags |
Enumerates all files that have been changed (added, removed, or edited). | ISandboxInstance.h | |
| This is the metadata that the sandbox has when it was created / loaded. | ISandboxInstance.h | ||
const TCHAR * GetRootDirectory() |
ISandboxInstance.h | ||
| ISandboxInstance.h | |||
bool HasFileChanges () |
This does not include packages with in-memory changes only. | ISandboxInstance.h | |
FSimpleMulticastDelegate & OnSandboxedFilesChanged() |
ISandboxInstance.h | ||
bool PersistAll() |
Persists all files. | ISandboxInstance.h | |
FPersistResult PersistSandbox
(
const FPersistArgs& InArgs |
More advanced version of PersistAll that gives you more control how persisting should occur. | ISandboxInstance.h | |
FRevertResult RevertAll() |
Reverts all files to the state they had before the sandbox. | ISandboxInstance.h | |
FRevertResult RevertSandbox
(
const FRevertArgs& InArgs |
More advanced version that gives you full control: specifically when packages are hot-reloaded and purged. | ISandboxInstance.h | |
FRevertResult RevertSpecified
(
const TConstArrayView< FString >& InFiles |
Reverts the files you specify to the state they had before the sandbox. | ISandboxInstance.h |