Navigation
API > API/Runtime > API/Runtime/BuildPatchServices
Interface to a Build Installer, exposes installation control, progress, and state information.
| Name | IBuildInstaller |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/BuildPatchServices/Public/Interfaces/IBuildInstaller.h |
| Include Path | #include "Interfaces/IBuildInstaller.h" |
Syntax
class IBuildInstaller
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IBuildInstaller() |
Virtual destructor. | Interfaces/IBuildInstaller.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CancelInstall() |
Cancel the current install | Interfaces/IBuildInstaller.h | |
bool CompletedSuccessfully () |
Get whether the process was successfully complete, meaning no errors, and was not cancelled. | Interfaces/IBuildInstaller.h | |
FBuildInstallStats GetBuildStatistics() |
Get the build stats for the process. This should only be called after the install has completed | Interfaces/IBuildInstaller.h | |
const BuildPatchServices::FBuildInstallerConfiguration & GetConfiguration() |
Get the installation configuration object | Interfaces/IBuildInstaller.h | |
| Returns debug text for download screen to help troubleshoot download issues | Interfaces/IBuildInstaller.h | ||
EBuildPatchDownloadHealth GetDownloadHealth() |
Get the current download health rating. | Interfaces/IBuildInstaller.h | |
double GetDownloadSpeed() |
Get the download speed for the current process | Interfaces/IBuildInstaller.h | |
FText GetDownloadSpeedText() |
Interfaces/IBuildInstaller.h | ||
| Get the installation error code. | Interfaces/IBuildInstaller.h | ||
FText GetErrorText() |
Get the display text for the error that occurred. Only valid to call after completion | Interfaces/IBuildInstaller.h | |
EBuildPatchInstallError GetErrorType() |
Get the type of error for a failure that has occurred. | Interfaces/IBuildInstaller.h | |
TMap< FString, TArray64< uint8 > > & GetFilesInstalledToMemory () |
Get the completed files when installing to memory. | Interfaces/IBuildInstaller.h | |
virtual int64 GetInitialDownloadSize() |
Interfaces/IBuildInstaller.h | ||
FText GetPercentageText() |
Interfaces/IBuildInstaller.h | ||
BuildPatchServices::EBuildPatchState GetState() |
Get the status of the install process. | Interfaces/IBuildInstaller.h | |
FText GetStatusText() |
Interfaces/IBuildInstaller.h | ||
int64 GetTotalDownloaded() |
Get the total bytes downloaded | Interfaces/IBuildInstaller.h | |
int64 GetTotalDownloadRequired() |
Get the total download bytes required to complete | Interfaces/IBuildInstaller.h | |
float GetUpdateProgress() |
Get the update progress | Interfaces/IBuildInstaller.h | |
bool HasError() |
Get whether the install failed. Only valid if complete. | Interfaces/IBuildInstaller.h | |
bool IsCanceled() |
Get whether the install was canceled. Only valid if complete. | Interfaces/IBuildInstaller.h | |
bool IsComplete() |
Get whether the install has complete | Interfaces/IBuildInstaller.h | |
bool IsPaused() |
Get whether the install is currently paused. | Interfaces/IBuildInstaller.h | |
bool IsResumable() |
Get whether the install can be resumed. | Interfaces/IBuildInstaller.h | |
bool IsUpdate() |
Get whether the install is performing an update of an existing install. | Interfaces/IBuildInstaller.h | |
void RegisterMessageHandler
(
BuildPatchServices::FMessageHandler* MessageHandler |
Registers a message handler with the installer. | Interfaces/IBuildInstaller.h | |
bool StartInstallation() |
Begin the installation process. | Interfaces/IBuildInstaller.h | |
bool TogglePauseInstall() |
Toggle the install paused state | Interfaces/IBuildInstaller.h | |
void UnregisterMessageHandler
(
BuildPatchServices::FMessageHandler* MessageHandler |
Unregisters a message handler, will no longer receive HandleMessage calls. | Interfaces/IBuildInstaller.h |