Navigation
API > API/Runtime > API/Runtime/InstallBundleManager
Handles calculating the bundle status by combining progress from all of its Prerequisites. Allows you to display one progress percent that is weighted based on all bundles' values.
| Name | FInstallBundleCombinedProgressTracker |
| Type | class |
| Header File | /Engine/Source/Runtime/InstallBundleManager/Public/BundlePrereqCombinedStatusHelper.h |
| Include Path | #include "BundlePrereqCombinedStatusHelper.h" |
Syntax
class FInstallBundleCombinedProgressTracker
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FInstallBundleCombinedProgressTracker
(
bool bAutoTick, |
BAutoTick Whehter this tracker should automatically Tick | BundlePrereqCombinedStatusHelper.h | |
| BundlePrereqCombinedStatusHelper.h | |||
| BundlePrereqCombinedStatusHelper.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FInstallBundleCombinedProgressTracker() |
BundlePrereqCombinedStatusHelper.h |
Structs
| Name | Remarks |
|---|---|
| FCombinedProgress | Provide all our needed combined status information in 1 struct |
Enums
Public
| Name | Remarks |
|---|---|
| ECombinedBundleStatus | Collapses all the bundle manager states into one of a few states so that you can show simple text based on this enum. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BundleStatusCache | TMap< FName, FInstallBundleProgress > | Internal Cache of all bundle statuses to track progress. | BundlePrereqCombinedStatusHelper.h | |
| CachedBundleWeights | TMap< FName, float > | Bundle weights that determine what % of the overall install each bundle represents. | BundlePrereqCombinedStatusHelper.h | |
| CurrentCombinedProgress | FCombinedProgress | BundlePrereqCombinedStatusHelper.h | ||
| InstallBundleManager | TWeakPtr< IInstallBundleManager > | BundlePrereqCombinedStatusHelper.h | ||
| OnTick | TUniqueFunction< void(const FCombinedProgress &)> | BundlePrereqCombinedStatusHelper.h | ||
| RequiredBundleNames | TArray< FName > | All bundles we need including pre-reqs. | BundlePrereqCombinedStatusHelper.h | |
| TickHandle | FTSTicker::FDelegateHandle | BundlePrereqCombinedStatusHelper.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ForceTick() |
Useful for resolving tick order issue. | BundlePrereqCombinedStatusHelper.h | |
const FCombinedProgress & GetCurrentCombinedProgress() |
Get current CombinedBundleStatus for everything setup to track. | BundlePrereqCombinedStatusHelper.h | |
void SetBundlesToTrackFromContentState
(
const FInstallBundleCombinedContentState& BundleContentState, |
Setup tracking for all bundles required in the supplied BundleContentState. | BundlePrereqCombinedStatusHelper.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| BundlePrereqCombinedStatusHelper.h | |||
FInstallBundleCombinedProgressTracker & operator=
(
const FInstallBundleCombinedProgressTracker& Other |
BundlePrereqCombinedStatusHelper.h |