Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > BuildPatchServices > Interfaces > IBuildInstaller

Light Theme

Dark Theme

IBuildInstaller

Interface to a Build Installer, exposes installation control, progress, and state information.

Windows

MacOS

Linux

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

	Name	Description
	~IBuildInstaller()	Virtual destructor.

Functions

	Name	Description
void	CancelInstall()	Cancel the current install
bool	CompletedSuccessfully()	Get whether the process was successfully complete, meaning no errors, and was not cancelled.
FBuildInstal...	GetBuildStatistics()	Get the build stats for the process. This should only be called after the install has completed
const BuildP...	GetConfiguration()	Get the installation configuration object
EBuildPatchD...	GetDownloadHealth()	Get the current download health rating.
double	GetDownloadSpeed()	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
EBuildPatchI...	GetErrorType()	Get the type of error for a failure that has occurred.
BuildPatchSe...	GetState()	Get the status of the install process.
int64	GetTotalDownloaded()	Get the total bytes downloaded
int64	GetTotalDownloadRequired()	Get the total download bytes required to complete
float	GetUpdateProgress()	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... )	Registers a message handler with the installer.
bool	StartInstallation()	Begin the installation process.
bool	TogglePauseInstall()	Toggle the install paused state
void	UnregisterMessageHandler ( BuildPatchServices::FMessageHandler... )	Unregisters a message handler, will no longer receive HandleMessage calls.

Deprecated Functions

	Name	Description
FText	GetDownloadSpeedText()	GetDownloadSpeedText has been deprecated. It will no longer be supported in the future.
int64	GetInitialDownloadSize()	GetInitialDownloadSize has been deprecated. Please use GetTotalDownloadRequired instead.
FText	GetPercentageText()	GetPercentageText has been deprecated. It will no longer be supported in the future.
FText	GetStatusText()	GetStatusText has been deprecated. It will no longer be supported in the future.

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

Take our survey

Dismiss