FBuildInstallerConfiguration

Defines a list of all the options of an installation task.

Windows
MacOS
Linux

References

Module

BuildPatchServices

Header

/Engine/Source/Runtime/Online/BuildPatchServices/Public/BuildPatchSettings.h

Include

#include "BuildPatchSettings.h"

Syntax

struct FBuildInstallerConfiguration

Remarks

Defines a list of all the options of an installation task.

Variables

Name Description

Public variable

FString

 

BackupDirectory

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.

Public variable

bool

 

bAllowConcurrentExecution

Whether to allow this installation to run concurrently with any existing installations.

Public variable

bool

 

bRunRequiredPrereqs

Whether to run the prerequisite installer provided if it hasn't been ran before on this machine.

Public variable

TArray< FString...

 

ChunkDatabaseFiles

The list of chunk database filenames that will be used to pull patch data from.

Public variable

TArray< FString...

 

CloudDirectories

The list of cloud directory roots that will be used to pull patch data from. Empty array will use module's global setting.

Public variable

EDeltaPolicy

 

DeltaPolicy

The policy to follow for requesting an optimised delta.

Public variable

FString

 

InstallDirectory

The directory to install to.

Public variable

TArray< FInstal...

 

InstallerActions

The array of intended actions to perform.

Public variable

EInstallMode

 

InstallMode

The mode for installation.

Public variable

FString

 

StagingDirectory

The directory for storing the intermediate files. This would usually be inside the InstallDirectory. Empty string will use module's global setting.

Public variable

EVerifyMode

 

VerifyMode

The mode for verification. This will be overridden for any files referenced by a repair action.

Constructors

Name Description

Public function

FBuildInstallerConfiguration

(
    TArray< FInstallerAction > Installe...
)

Construct with an array of action objects

Public function

FBuildInstallerConfiguration

(
    const FBuildInstallerConfiguration ...
)

Copy constructor.

Public function

FBuildInstallerConfiguration

(
    FBuildInstallerConfiguration&& Mov...
)

RValue constructor to allow move semantics.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss