Navigation
| Name | FileSandboxCore |
| Type | Developer |
| Part of Plugins | File Sandbox |
| Location | /Engine/Plugins/Developer/Sandbox/FileSandbox/Source/FileSandboxCore/ |
| Module Build Rules | FileSandboxCore.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FAggregatePersistFeedback | Forwards the errors to other error handlers. |
| FAppendTextPersistFeedback | |
| FDefaultPackageReloadHandler | Default implementation for reloading assets. |
Structs
| Name | Remarks |
|---|---|
| FDeleteSandboxByDirectoryArgs | Args for deleting sandbox by directory. |
| FDeleteSandboxByNameArgs | Args for deleting sandbox by name. |
| FDeleteSandboxResult | Describes the result of the delete operation, with a reason of why it failed. |
| FFileSandboxCore_CustomVersionInfo | Holds custom version information |
| FFileSandboxCore_EngineVersionInfo | Holds engine version information |
| FFileSandboxCore_FileVersionInfo | Holds file version information |
| FFileSandboxCore_InstancedStructMap | Advanced tagging structure. Each USTRUCT() can be added at most once. |
| FFileSandboxCore_SandboxMetaData | Metadata about a sandbox. |
| FFileSandboxCore_VersionInfo | Holds version information for a session |
| FGatheredFileChanges | Result of ISandboxInstance::GatherChangedFiles. |
| FHotReloadPackageArgs | Arguments for hot reloading packages. |
| FImportInspectionResult | Holds the result for inspecting whether a zip archive is suitable for importing. |
| FLeaveSandboxArgs | Describes how the session is supposed to be left. |
| FLeaveSandboxResult | Describes the result of the leave operation, with a reason of why it failed. |
| FLoadSandboxByDirectoryArgs | Args for loading a pre-existing sandbox. |
| FLoadSandboxByNameArgs | Args for loading a pre-existing sandbox. |
| FLoadSandboxError | Explains why a new sandbox could not be loaded. |
| FNewSandboxArgs | Args for creating a new sandbox. |
| FNewSandboxError | Explains why a new sandbox could not be created. |
| FPersistArgs | Input arguments for persisting a sandbox. |
| FPersistedFileInfo | |
| FPersistResult | Result of a persist. |
| FPurgePackageArgs | Arguments for purging packages. |
| FRepositoryChangedEvent | Data describing a change in a repository |
| FRevertArgs | Input arguments for reverting a sandbox. |
| FRevertResult | Result of reverting a sandbox. |
| FSandboxedFileChangeInfo | Info about each file change enumerated. |
| FSandboxInitArgs | Arguments for creating a sandbox. |
| FSandboxMetaInfo | |
| TSandboxCreationResult | Utility type to allow implicit conversion to ISandboxInstance*, i.e. to allow shorthand semantics such as ISandboxManager* Manager = ...; if (ISandboxInstance* SandboxInstance = Manager->LoadNamedSandbox(...)) { ... } |
Interfaces
| Name | Remarks |
|---|---|
| IFileSandboxCoreModule | |
| IPackageReloadHandler | Interface to customize hot-reloading and purging of assets. |
| IPersistFeedback | You can implement this to get interactive information about a persist operation. |
| ISandboxInstance | Manages the file sandbox. |
| ISandboxLock | Interface to allow module to determine whether a sandbox can be left. |
| ISandboxManager | Manages the lifetime of the ISandboxInstance. |
| ISandboxRepository | Knows of the sandboxes instances available. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FConsumeFileSignature | EBreakBehavior(const FString &) | ISandboxInstance.h | |
| FLoadSandboxResult | TSandboxCreationResult< FLoadSandboxError > | Types/ArgsFwds.h | |
| FNewSandboxResult | TSandboxCreationResult< FNewSandboxError > | Types/ArgsFwds.h | |
| FOnSandboxesChanged | TMulticastDelegate_OneParam< void, const FRepositoryChangedEvent & > | ISandboxRepository.h | |
| FOnSandboxMetaDataChanged | TMulticastDelegate_OneParam< void, const FString & > | ISandboxRepository.h | |
| FProcessFileChangeSignature | EBreakBehavior(const FSandboxedFileChangeInfo &InFileInfo) | Types/ArgsFwds.h | |
| FProcessSandboxDirectorySignature | EBreakBehavior(const FString &InBaseDirectory) | Utils/SandboxDirectoryUtils.h | |
| FSandboxInstanceEvent | TMulticastDelegate_OneParam< void, ISandboxInstance & > | ISandboxManager.h | |
| FSandboxShutdownEvent | FSimpleMulticastDelegate | ISandboxManager.h |
Enums
Public
| Name | Remarks |
|---|---|
| UE::FileSandboxCore::EBreakBehavior | |
| UE::FileSandboxCore::EDeleteSandboxErrorCode | |
| UE::FileSandboxCore::EDirectorySuitability | |
| UE::FileSandboxCore::EFileChangeGatherFlags | Specifies what information should be gathered about files |
| UE::FileSandboxCore::EFileEnumerationFlags | Flags enumerating file changes. |
| UE::FileSandboxCore::ELeaveSandboxErrorCode | |
| UE::FileSandboxCore::ELoadSandboxLoadErrorReason | |
| UE::FileSandboxCore::ENewSandboxErrorReason | |
| UE::FileSandboxCore::EPersistStatus | Possible outcomes from a session persist. |
| UE::FileSandboxCore::ESandboxFileChange | Types of changes the sandbox system may make to a file. |
| UE::FileSandboxCore::ESandboxInitFlags | |
| UE::FileSandboxCore::ESandboxPackageReloadPhase | Specifies a stage at which packages may be reloaded while sandboxed. |
| UE::FileSandboxCore::ESandboxRenameSuitability | Explains why a sandbox can or cannot be renamed. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool UE::FileSandboxCore::HasDirtyPackages() |
Utils/PackageSandboxUtils.h | ||
| Types/GatheredFileChanges.h | |||
| Types/SandboxedFileChangeInfo.h | |||
bool UE::FileSandboxCore::operator!
(
ESandboxInitFlags E |
Types/SandboxInitFlags.h | ||
| Types/GatheredFileChanges.h | |||
| Types/SandboxedFileChangeInfo.h | |||
| Types/SandboxInitFlags.h | |||
| Types/GatheredFileChanges.h | |||
| Types/SandboxedFileChangeInfo.h | |||
| Types/SandboxInitFlags.h | |||
| Types/GatheredFileChanges.h | |||
| Types/SandboxedFileChangeInfo.h | |||
| Types/SandboxInitFlags.h | |||
| Types/GatheredFileChanges.h | |||
| Types/SandboxedFileChangeInfo.h | |||
| Types/SandboxInitFlags.h | |||
| Types/GatheredFileChanges.h | |||
| Types/SandboxedFileChangeInfo.h | |||
| Types/SandboxInitFlags.h | |||
| Types/GatheredFileChanges.h | |||
| Types/SandboxedFileChangeInfo.h | |||
| Types/SandboxInitFlags.h | |||
| Types/GatheredFileChanges.h | |||
| Types/SandboxedFileChangeInfo.h | |||
| Types/SandboxInitFlags.h | |||
FLazyName UE::FileSandboxCore::Tag_CommandLineSandbox
(
"CommandLineSandbox" |
Tag added to sandboxes that were created from command line. | Utils/BuiltInTags.h |