Navigation
API > API/Runtime > API/Runtime/BuildPatchServices
Defines a list of all the options of an installation task.
| Name | FBuildInstallerConfiguration |
| Type | struct |
| Header File | /Engine/Source/Runtime/Online/BuildPatchServices/Public/BuildPatchSettings.h |
| Include Path | #include "BuildPatchSettings.h" |
Syntax
struct FBuildInstallerConfiguration
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBuildInstallerConfiguration
(
TArray< FInstallerAction > InstallerActions |
Construct with an array of action objects | BuildPatchSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BackupDirectory | FString | The directory for placing files that are believed to have local changes, before we overwrite them. Empty string will use module's global setting. If both empty, the feature disables. | BuildPatchSettings.h | |
| bAllowConcurrentExecution | bool | Whether to allow this installation to run concurrently with any existing installations. | BuildPatchSettings.h | |
| bCalculateDeleteChunkDbMaxDiskSpaceAndExit | bool | If set, don't actually do an installation, just figure out how much disk space is required if we are using entirely chunkdbs and we delete them as we go. | BuildPatchSettings.h | |
| bDeleteChunkDbFilesAfterUse | bool | If set, when we've read everything we're going to read from a chunkdb file, we delete it to minimize required disk space for install/patch. | BuildPatchSettings.h | |
| bRunRequiredPrereqs | bool | Whether to run the prerequisite installer provided if it hasn't been ran before on this machine. | BuildPatchSettings.h | |
| bTrackFileOperations | bool | Whether to gather individual file operation statistics during install. | BuildPatchSettings.h | |
| ChunkDatabaseFiles | TArray< FString > | The list of chunk database filenames that will be used to pull patch data from. These must be local (i.e. no URLs) | BuildPatchSettings.h | |
| CloudDirectories | TArray< FString > | The list of cloud directory roots that will be used to pull patch data from. | BuildPatchSettings.h | |
| ConstructorDisableResumeBelowMB | TOptional< int32 > | Whether to disable resume on clean installs below a given threshold, in megabytes. | BuildPatchSettings.h | |
| ConstructorIOBatchSizeMB | TOptional< int32 > | File constructor batch size, in MB. | BuildPatchSettings.h | |
| ConstructorIOBufferSizeMB | TOptional< int32 > | File constructor buffer size, in MB. | BuildPatchSettings.h | |
| ConstructorSpawnAdditionalIOThreads | TOptional< bool > | Whether the file constructor is allowed to spawn multiple threads for IO read/write servicing. | BuildPatchSettings.h | |
| ConstructorStallWhenFileSystemThrottled | TOptional< bool > | Whether the file construction should adhere to file system write limits. | BuildPatchSettings.h | |
| DeltaPolicy | EDeltaPolicy | The policy to follow for requesting an optimised delta. | BuildPatchSettings.h | |
| InstallDirectory | FString | The directory to install to. | BuildPatchSettings.h | |
| InstallerActions | TArray< FInstallerAction > | The array of intended actions to perform. | BuildPatchSettings.h | |
| InstallMode | EInstallMode | The mode for installation. | BuildPatchSettings.h | |
| SharedContext | IBuildInstallerSharedContextPtr | The context for allocating shared resources. | BuildPatchSettings.h | |
| StagingDirectory | FString | The directory for storing the intermediate files. This would usually be inside the InstallDirectory. Empty string will use module's global setting. | BuildPatchSettings.h | |
| VerifyMode | EVerifyMode | The mode for verification. This will be overridden for any files referenced by a repair action. | BuildPatchSettings.h |