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 > FBuildInstallStats

Light Theme

Dark Theme

FBuildInstallStats

A struct to hold stats for the build process.

Windows

MacOS

Linux

References

Module	BuildPatchServices
Header	/Engine/Source/Runtime/Online/BuildPatchServices/Public/Interfaces/IBuildInstaller.h
Include	#include "Interfaces/IBuildInstaller.h"

Syntax

struct FBuildInstallStats

Remarks

A struct to hold stats for the build process.

Variables

	Name	Description
uint32	ActiveRequestCountPeak	The peak number of simultaneous download requests.
double	AverageDiskReadSpeed	The average disk read speed.
double	AverageDiskWriteSpeed	The average disk write speed.
double	AverageDownloadSpeed	The average chunk download speed.
float	AverageMemoryStoreRetained	AverageMemoryStoreRetained.
float	AverageMemoryStoreUse	AverageMemoryStoreUse.
uint32	ChunksInChunkDbs	The number of chunks available in chunkdb files.
uint32	ChunksLocallyAvailable	The number of chunks locally available in the build.
uint32	ChunksQueuedForDownload	The number of required chunks queued for download.
float	CleanUpTime	The time spent during the clean up stage.
float	ConstructTime	The time spent during the construction stage.
float	DisconnectedDownloadHealthTime	The amount of time that was spent with Disconnected download health.
FString	ErrorCode	The error code. No error results in 'OK'.
float	ExcellentDownloadHealthTime	The amount of time that was spent with Excellent download health.
FText	FailureReasonText	The localized, more generic failure reason.
EBuildPatchInst...	FailureType	The failure type for the install.
float	FileAttributesTime	The time spent during the file attribution stage.
double	FinalDownloadSpeed	The download speed registered at the end of the installation.
float	FinalProgress	Final progress state, this is the progress of the current retry attempt.
float	GoodDownloadHealthTime	The amount of time that was spent with Good download health.
float	InitializeTime	The time spent during the initialization stage.
uint32	MemoryStoreSize	MemoryStoreSize.
float	MoveFromStageTime	The time spent moving staged files into the installation location.
uint32	NumAbortedDownloads	The number of chunks we aborted as they were determined as taking too long.
uint32	NumBadDownloads	The number of chunks we received but were determined bad data.
uint32	NumChunkDbChunksFailed	The number of chunks that were not successfully loaded from provided chunkdbs.
uint32	NumChunksDownloaded	The total number of chunks that were downloaded.
uint32	NumChunksReadFromChunkDbs	The number of chunks successfully read from chunkdbs.
uint32	NumChunksRecycled	The number of chunks successfully recycled.
uint32	NumChunksRequired	The total number of chunks making up those files.
uint32	NumChunksStoreBooted	The number of chunks that had to be booted from the memory stores.
uint32	NumDriveStoreChunkLoads	The number of chunks that had to be loaded from the drive store.
uint32	NumDriveStoreLoadFailures	The number of chunks that failed to load from the drive store.
uint32	NumFailedDownloads	The number of chunks we did not successfully receive.
uint32	NumFilesConstructed	The total number of files constructed.
uint32	NumFilesInBuild	The total number of files in the build.
uint32	NumFilesOutdated	The total number of files outdated.
uint32	NumFilesToRemove	The total number of files in the previous build that can be deleted.
uint32	NumInstallRetries	The number of times the system looped to retry.
uint32	NumRecycleFailures	The number of chunks that failed to be recycled from existing build.
float	OkDownloadHealthTime	The amount of time that was spent with OK download health.
float	OverallRequestSuccessRate	The overall rate of success for download requests.
double	PeakDiskReadSpeed	The peak disk read speed.
double	PeakDiskWriteSpeed	The peak disk write speed.
double	PeakDownloadSpeed	The peak chunk download speed.
uint32	PeakMemoryStoreRetained	PeakMemoryStoreRetained.
uint32	PeakMemoryStoreUse	PeakMemoryStoreUse.
float	PoorDownloadHealthTime	The amount of time that was spent with Poor download health.
float	PrereqTime	The time spent during the prerequisite stage.
float	ProcessActiveTime	The amount of time that was spent active (un-paused).
uint64	ProcessAvailableDiskSpace	The total number of bytes available at the time of checking ProcessRequiredDiskSpace.
float	ProcessExecuteTime	The total time that the install process took to complete.
float	ProcessPausedTime	The amount of time that was spent paused.
uint64	ProcessRequiredDiskSpace	The total number of bytes required to start the installation.
bool	ProcessSuccess	Whether the process was successful.
TArray< FString...	RetryErrorCodes	If NumInstallRetries > 0, this will contain the list of error codes for each retry.
TArray< EBuildP...	RetryFailureTypes	If NumInstallRetries > 0, this will contain the list of retry reasons for retrying.
float	TheoreticalDownloadTime	The theoretical download time (data/speed).
uint64	TotalDownloadedData	The total number of bytes downloaded.
uint64	TotalReadData	The total number of bytes read to disk.
uint64	TotalWrittenData	The total number of bytes written to disk.
float	VerifyTime	The time spent during the verification stage.

Constructors

	Name	Description
	FBuildInstallStats()	Constructor.

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

Take our survey

Dismiss