Navigation
Unreal Engine C++ API Reference > Runtime > BuildPatchServices > Interfaces
References
| Module | BuildPatchServices |
| Header | /Engine/Source/Runtime/Online/BuildPatchServices/Public/Interfaces/IBuildInstaller.h |
| Include | #include "Interfaces/IBuildInstaller.h" |
Syntax
class IBuildInstaller
Remarks
Interface to a Build Installer, exposes installation control, progress, and state information.
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Virtual destructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Cancel the current install | |
  |
bool | Get whether the process was successfully complete, meaning no errors, and was not cancelled. | |
  |
FBuildInstallStats | Get the build stats for the process. This should only be called after the install has completed | |
  |
const BuildPatchServices::FBuildInstallerConfiguration & | Get the installation configuration object | |
  |
EBuildPatchDownloadHealth | Get the current download health rating. | |
  |
double | Get the download speed for the current process | |
  |
FString | GetErrorCode () |
Get the installation error code. |
  |
FText | GetErrorText () |
Get the display text for the error that occurred. Only valid to call after completion |
  |
EBuildPatchInstallError | GetErrorType () |
Get the type of error for a failure that has occurred. |
  |
BuildPatchServices::EBuildPatchState | GetState () |
Get the status of the install process. |
  |
int64 | Get the total bytes downloaded | |
  |
int64 | Get the total download bytes required to complete | |
  |
float | Get the update progress | |
  |
bool | HasError () |
Get whether the install failed. Only valid if complete. |
  |
bool | IsCanceled () |
Get whether the install was canceled. Only valid if complete. |
  |
bool | IsComplete () |
Get whether the install has complete |
  |
bool | IsPaused () |
Get whether the install is currently paused. |
  |
bool | IsResumable () |
Get whether the install can be resumed. |
  |
bool | IsUpdate () |
Get whether the install is performing an update of an existing install. |
 |
void | RegisterMessageHandler
(
BuildPatchServices::FMessageHandler* MessageHandler |
Registers a message handler with the installer. |
 |
bool | Begin the installation process. | |
 |
bool | Toggle the install paused state | |
 |
void | UnregisterMessageHandler
(
BuildPatchServices::FMessageHandler* MessageHandler |
Unregisters a message handler, will no longer receive HandleMessage calls. |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FText | GetDownloadSpeedText has been deprecated. It will no longer be supported in the future. | |
   |
int64 | GetInitialDownloadSize has been deprecated. Please use GetTotalDownloadRequired instead. | |
  |
FText | GetPercentageText has been deprecated. It will no longer be supported in the future. | |
  |
FText | GetStatusText has been deprecated. It will no longer be supported in the future. |