Navigation
API > API/Runtime > API/Runtime/InstallBundleManager
| Name | FInstallBundleReport |
| Type | struct |
| Header File | /Engine/Source/Runtime/InstallBundleManager/Public/InstallBundleManagerReporting.h |
| Include Path | #include "InstallBundleManagerReporting.h" |
Syntax
struct FInstallBundleReport : public FJsonSerializable
Inheritance Hierarchy
- FJsonSerializable → FInstallBundleReport
Structs
| Name | Remarks |
|---|---|
| FStateInstalling | |
| FStateUpdatable | State that represents an updatable bundle, where a choice can be made to update in the background, or without. |
| FStateUpdated | State that represents a fully updated bundle that no longer needs to be updated. |
| FStateUpdating | State that represents a bundle that is updating. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FState | TVariant< FStateUpdatable, FStateUpdating, FStateInstalling, FStateUpdated > | InstallBundleManagerReporting.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BundleName | FName | The name of the bundle. | InstallBundleManagerReporting.h | |
| SourceVersion | TOptional< FString > | A string specifying what content version is being upgraded FROM. | InstallBundleManagerReporting.h | |
| State | TOptional< FState > | The state of the bundle. | InstallBundleManagerReporting.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddDiscrepancy
(
uint64 Bytes |
Adds missing bytes to content size and download progress. | InstallBundleManagerReporting.h | |
uint64 DownloadedBytes() |
Returns the amount of downloaded bytes for this bundle, should always be 0 <= x <= TotalDownloadSize() | InstallBundleManagerReporting.h | |
float InstallationProgress () |
Returns a value 0 <= x <= 1 to indicate the installation progress. | InstallBundleManagerReporting.h | |
bool IsInstalling() |
InstallBundleManagerReporting.h | ||
bool IsUnknown() |
InstallBundleManagerReporting.h | ||
bool IsUpdatable() |
InstallBundleManagerReporting.h | ||
bool IsUpdated() |
InstallBundleManagerReporting.h | ||
bool IsUpdating() |
InstallBundleManagerReporting.h | ||
BEGIN_JSON_SERIALIZER JSON_SERIALIZE_NAME
(
"Name", |
InstallBundleManagerReporting.h | ||
JSON_SERIALIZE_OPTIONAL
(
"SourceVersion", |
InstallBundleManagerReporting.h | ||
JSON_SERIALIZE_OPTIONAL_VARIANT_BEGIN
(
"State", |
InstallBundleManagerReporting.h | ||
JSON_SERIALIZE_OPTIONAL_VARIANT_END() |
InstallBundleManagerReporting.h | ||
JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE
(
"StateUpdatable", |
InstallBundleManagerReporting.h | ||
JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE
(
"StateUpdating", |
InstallBundleManagerReporting.h | ||
JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE
(
"StateInstalling", |
InstallBundleManagerReporting.h | ||
JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE
(
"StateUpdated", |
InstallBundleManagerReporting.h | ||
END_JSON_SERIALIZER uint64 TotalDownloadSize() |
Returns the total amount of bytes that will or has been downloaded for this bundle. | InstallBundleManagerReporting.h |