Navigation
API > API/Runtime > API/Runtime/InstallBundleManager
| Name | FInstallManagerBundleReport |
| Type | struct |
| Header File | /Engine/Source/Runtime/InstallBundleManager/Public/InstallBundleManagerReporting.h |
| Include Path | #include "InstallBundleManagerReporting.h" |
Syntax
struct FInstallManagerBundleReport : public FJsonSerializable
Inheritance Hierarchy
- FJsonSerializable → FInstallManagerBundleReport
Enums
Public
| Name | Remarks |
|---|---|
| ECombinedStatus |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BackgroundedCount | TOptional< uint32 > | Indicates, if set, how many times the application was backgrounded during the update process for this bundle. | InstallBundleManagerReporting.h | |
| ContextName | FName | The context name for this bundle report | InstallBundleManagerReporting.h | |
| LoadedCount | uint32 | Indicates how many times this report has been loaded from disk; in other words, indicates how many times the update process was restarted. | InstallBundleManagerReporting.h | |
| SessionId | FString | Semi-unique session string, changes every time any bundle source decides to start updating to a new version; generated using UUID. | InstallBundleManagerReporting.h | |
| SourceReports | TArray< FInstallBundleSourceReport > | Array containing a single source report for every unique source bundle the manager knows. | InstallBundleManagerReporting.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint64 DownloadedBytes() |
Returns the amount of downloaded bytes, should always be 0 <= x <= TotalDownloadSize() | InstallBundleManagerReporting.h | |
FInstallBundleSourceReport & FindOrAddBundleSourceReport
(
const FInstallBundleSourceType& Type |
Returns a reference to the bundle source report for the given type. | InstallBundleManagerReporting.h | |
ECombinedStatus GetCombinedStatus() |
Returns a combined status of all bundles. | InstallBundleManagerReporting.h | |
float GetDownloadProgress() |
Returns the download progress. This returns a value 0 <= x <= 1. | InstallBundleManagerReporting.h | |
TOptional< FString > GetHighestCurrentBundleVersion() |
Returns the highest current versions of any bundle. If not a single bundle has a version set, this returns an empty optional. | InstallBundleManagerReporting.h | |
float GetInstallationProgress() |
Returns the overall installation progress, which is separate from the download progress This returns a value 0 <= x <= 1. | InstallBundleManagerReporting.h | |
FString GetLongProgressString() |
Returns a longer progress string with more information. | InstallBundleManagerReporting.h | |
TOptional< FString > GetLowestCurrentBundleVersion () |
Returns the lowest current versions of any bundle. | InstallBundleManagerReporting.h | |
FString GetProgressString() |
Returns a progress string. | InstallBundleManagerReporting.h | |
JSON_SERIALIZE
(
"SessionId", |
InstallBundleManagerReporting.h | ||
JSON_SERIALIZE
(
"LoadedCount", |
InstallBundleManagerReporting.h | ||
JSON_SERIALIZE_ARRAY_SERIALIZABLE
(
"SourceReports", |
InstallBundleManagerReporting.h | ||
BEGIN_JSON_SERIALIZER JSON_SERIALIZE_NAME
(
"ContextName", |
InstallBundleManagerReporting.h | ||
JSON_SERIALIZE_OPTIONAL
(
"BackgroundedCount", |
InstallBundleManagerReporting.h | ||
int TotalBundleCount() |
Returns the total amount of bundles being updated, regardless of their state. | InstallBundleManagerReporting.h | |
uint64 TotalDownloadSize() |
Returns the total amount of bytes that will or has been downloaded. | InstallBundleManagerReporting.h | |
END_JSON_SERIALIZER FInstallBundleSourceReport * TryFindBundleSourceReport
(
const FInstallBundleSourceType& Type |
Returns pointer to bundle source report that's valid as long as SourceReports is not modified. | InstallBundleManagerReporting.h | |
int UpdatedBundleCount() |
Returns the amount of bundles that has being updated. | InstallBundleManagerReporting.h |