UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Namespaces | Macros | Enumerations | Functions
InstallBundleTypes.h File Reference
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "Containers/Map.h"
#include "Containers/Set.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "Delegates/Delegate.h"
#include "GenericPlatform/GenericPlatformFile.h"
#include "HAL/Platform.h"
#include "Internationalization/Text.h"
#include "Misc/DateTime.h"
#include "Misc/EnumClassFlags.h"
#include "Misc/EnumRange.h"
#include "Misc/TVariant.h"
#include "UObject/NameTypes.h"

Go to the source code of this file.

Classes

class  FInstallBundleSourceType
 
struct  FInstallBundleCombinedInstallState
 
struct  FInstallBundleContentState
 
struct  FInstallBundleContentSize
 
struct  FInstallBundleCombinedContentState
 
struct  FInstallBundleSourceInitInfo
 
struct  FInstallBundleSourceAsyncInitInfo
 
struct  FInstallBundleSourceUpdateBundleInfo
 
struct  FInstallBundleSourceUpdateBundleInfoResult
 
struct  FInstallBundleSourcePersistentBundleInfo
 
struct  FInstallBundleSourceBundleInfoQueryResult
 
struct  FInstallBundleSourceUpdateContentResultInfo
 
struct  FInstallBundleSourceReleaseContentResultInfo
 
struct  FBuildInstallerStat
 
struct  FInstallBundleSourceProgress
 
struct  FInstallBundleSourcePauseInfo
 
struct  FInstallBundleCacheBundleStats
 
struct  FInstallBundleCacheStats
 
struct  FBundleRequestCompleteInfo
 

Namespaces

namespace  UE
 
namespace  UE::IoStore
 NO_LOGGING.
 

Macros

#define WITH_PLATFORM_INSTALL_BUNDLE_SOURCE   0
 

Enumerations

enum class  EInstallBundleManagerInitState : int { NotInitialized , Failed , Succeeded }
 
enum class  EInstallBundleManagerInitResult : int {
  OK , BuildMetaDataNotFound , RemoteBuildMetaDataNotFound , BuildMetaDataDownloadError ,
  BuildMetaDataParsingError , DistributionRootParseError , DistributionRootDownloadError , ManifestArchiveError ,
  ManifestCreationError , ManifestDownloadError , BackgroundDownloadsIniDownloadError , NoInternetConnectionError ,
  ConfigurationError , ClientPatchRequiredError , Count
}
 
enum class  EInstallBundleInstallState : int { NotInstalled , NeedsUpdate , UpToDate , Count }
 
enum class  EInstallBundleGetContentStateFlags : uint32 { None = 0 , UE_DEPRECATED =(5.7, "ForceNoPatching is no longer supported, use uninstall") = (1 << 0) , UpdateBundleReports = (1 << 1) }
 
enum class  EInstallBundleRequestInfoFlags : int32 {
  None = 0 , EnqueuedBundles = (1 << 0) , SkippedAlreadyMountedBundles = (1 << 1) , SkippedAlreadyUpdatedBundles = (1 << 2) ,
  SkippedAlreadyReleasedBundles = (1 << 3) , SkippedAlreadyRemovedBundles = (1 << 4) , SkippedUnknownBundles = (1 << 5) , SkippedInvalidBundles = (1 << 6) ,
  SkippedUnusableLanguageBundles = (1 << 7) , SkippedBundlesDueToBundleSource = (1 << 8)
}
 
enum class  EInstallBundleResult : uint32 {
  OK , FailedPrereqRequiresLatestClient , FailedPrereqRequiresLatestContent , FailedCacheReserve ,
  InstallError , InstallerOutOfDiskSpaceError , ManifestArchiveError , ConnectivityError ,
  UserCancelledError , InitializationError , InitializationPending , MetadataError ,
  Count
}
 
enum class  EInstallBundleRequestFlags : uint32 {
  None = 0 , CheckForCellularDataUsage = (1 << 0) , UE_DEPRECATED =(5.7, "UseBackgroundDownloads is no longer supported, done automatically") = (1 << 1) , SendNotificationIfDownloadCompletesInBackground = (1 << 2) ,
  UE_DEPRECATED =(5.7, "ForceNoPatching is no longer supported, use uninstall") = (1 << 3) , TrackPersistentBundleStats = (1 << 4) , SkipMount = (1 << 5) , AsyncMount = (1 << 6) ,
  UpdateBundleReports = (1 << 7) , ExplicitUpdateList = (1 << 8) , Defaults = None
}
 
enum class  EInstallBundleReleaseResult : uint32 {
  OK , ManifestArchiveError , UserCancelledError , MetadataError ,
  Count
}
 
enum class  EInstallBundleReleaseRequestFlags : uint32 { None = 0 , RemoveFilesIfPossible = (1 << 0) , ExplicitRemoveList = (1 << 1) , SkipReleaseUnmountOnly = (1 << 2) }
 
enum class  EInstallBundlePauseFlags : uint32 { None = 0 , OnCellularNetwork = (1 << 0) , NoInternetConnection = (1 << 1) , UserPaused = (1 << 2) }
 
enum class  EInstallBundleStatus : int {
  Requested , Updating , Finishing , Ready ,
  Count
}
 
enum class  EInstallBundleManagerPatchCheckResult : uint32 {
  NoPatchRequired , ClientPatchRequired , ContentPatchRequired , NoLoggedInUser ,
  PatchCheckFailure , Count
}
 
enum class  EInstallBundlePriority : uint8 { High , Normal , Low , Count }
 
enum class  EInstallBundleSourceUpdateBundleInfoResult : uint8 {
  OK , NotInitailized , AlreadyMounted , AlreadyRequested ,
  IllegalCacheStatus , Count
}
 
enum class  EInstallBundleSourceBundleSkipReason : uint32 { None = 0 , LanguageNotCurrent = (1 << 0) , NotValid = (1 << 1) }
 
enum class  EInstallBundleCacheStatsFlags : uint8 { None = 0 , DumpToLog = (1 << 0) , CSVFormat = (1 << 1) , DumpToResults = (1 << 2) }
 

Functions

enum UE_DEPRECATED(5.5, "Use FInstallBundleSourceType") EInstallBundleSourceType PRAGMA_DISABLE_DEPRECATION_WARNINGS ENUM_RANGE_BY_COUNT (EInstallBundleSourceType, EInstallBundleSourceType::Count)
 
INSTALLBUNDLEMANAGER_API const TCHAR * LexToString (EInstallBundleSourceType Type)
 
INSTALLBUNDLEMANAGER_API void LexFromString (EInstallBundleSourceType &OutType, const TCHAR *String)
 
INSTALLBUNDLEMANAGER_API const TCHAR * LexToString (FInstallBundleSourceType Type)
 
INSTALLBUNDLEMANAGER_API const TCHAR * LexToString (EInstallBundleManagerInitResult Result)
 
INSTALLBUNDLEMANAGER_API const TCHAR * LexToString (EInstallBundleInstallState State)
 
 ENUM_CLASS_FLAGS (EInstallBundleGetContentStateFlags)
 
 DECLARE_DELEGATE_OneParam (FInstallBundleGetContentStateDelegate, FInstallBundleCombinedContentState)
 
 ENUM_CLASS_FLAGS (EInstallBundleRequestInfoFlags)
 
INSTALLBUNDLEMANAGER_API const TCHAR * LexToString (EInstallBundleResult Result)
 
INSTALLBUNDLEMANAGER_API const TCHAR * LexToString (EInstallBundleReleaseResult Result)
 
 ENUM_CLASS_FLAGS (EInstallBundlePauseFlags)
 
INSTALLBUNDLEMANAGER_API const TCHAR * LexToString (EInstallBundleStatus Status)
 
INSTALLBUNDLEMANAGER_API const TCHAR * LexToString (EInstallBundleManagerPatchCheckResult EnumVal)
 
INSTALLBUNDLEMANAGER_API const TCHAR * LexToString (EInstallBundlePriority Priority)
 
INSTALLBUNDLEMANAGER_API bool LexTryParseString (EInstallBundlePriority &OutMode, const TCHAR *InBuffer)
 
INSTALLBUNDLEMANAGER_API const TCHAR * LexToString (EInstallBundleSourceUpdateBundleInfoResult Result)
 
 ENUM_CLASS_FLAGS (EInstallBundleSourceBundleSkipReason)
 
 ENUM_CLASS_FLAGS (EInstallBundleCacheStatsFlags)
 

Macro Definition Documentation

◆ WITH_PLATFORM_INSTALL_BUNDLE_SOURCE

#define WITH_PLATFORM_INSTALL_BUNDLE_SOURCE   0

Enumeration Type Documentation

◆ EInstallBundleCacheStatsFlags

enum class EInstallBundleCacheStatsFlags : uint8
strong
Enumerator
None 
DumpToLog 
CSVFormat 
DumpToResults 

◆ EInstallBundleGetContentStateFlags

enum class EInstallBundleGetContentStateFlags : uint32
strong
Enumerator
None 
UE_DEPRECATED 
UpdateBundleReports 

◆ EInstallBundleInstallState

enum class EInstallBundleInstallState : int
strong
Enumerator
NotInstalled 
NeedsUpdate 
UpToDate 
Count 

◆ EInstallBundleManagerInitResult

enum class EInstallBundleManagerInitResult : int
strong
Enumerator
OK 
BuildMetaDataNotFound 
RemoteBuildMetaDataNotFound 
BuildMetaDataDownloadError 
BuildMetaDataParsingError 
DistributionRootParseError 
DistributionRootDownloadError 
ManifestArchiveError 
ManifestCreationError 
ManifestDownloadError 
BackgroundDownloadsIniDownloadError 
NoInternetConnectionError 
ConfigurationError 
ClientPatchRequiredError 
Count 

◆ EInstallBundleManagerInitState

enum class EInstallBundleManagerInitState : int
strong
Enumerator
NotInitialized 
Failed 
Succeeded 

◆ EInstallBundleManagerPatchCheckResult

enum class EInstallBundleManagerPatchCheckResult : uint32
strong
Enumerator
NoPatchRequired 

No patch required

ClientPatchRequired 

Client Patch required to continue

ContentPatchRequired 

Content Patch required to continue

NoLoggedInUser 

Logged in user required for a patch check

PatchCheckFailure 

Patch check failed

Count 

◆ EInstallBundlePauseFlags

enum class EInstallBundlePauseFlags : uint32
strong
Enumerator
None 
OnCellularNetwork 
NoInternetConnection 
UserPaused 

◆ EInstallBundlePriority

enum class EInstallBundlePriority : uint8
strong

Enum used to describe download priority. Higher priorities will be downloaded first. Note: Should always be kept in High -> Low priority order if adding more Priorities!

Enumerator
High 
Normal 
Low 
Count 

◆ EInstallBundleReleaseRequestFlags

enum class EInstallBundleReleaseRequestFlags : uint32
strong
Enumerator
None 
RemoveFilesIfPossible 
ExplicitRemoveList 
SkipReleaseUnmountOnly 

◆ EInstallBundleReleaseResult

enum class EInstallBundleReleaseResult : uint32
strong
Enumerator
OK 
ManifestArchiveError 
UserCancelledError 
MetadataError 
Count 

◆ EInstallBundleRequestFlags

enum class EInstallBundleRequestFlags : uint32
strong
Enumerator
None 
CheckForCellularDataUsage 
UE_DEPRECATED 
SendNotificationIfDownloadCompletesInBackground 
UE_DEPRECATED 
TrackPersistentBundleStats 
SkipMount 
AsyncMount 
UpdateBundleReports 
ExplicitUpdateList 
Defaults 

◆ EInstallBundleRequestInfoFlags

enum class EInstallBundleRequestInfoFlags : int32
strong
Enumerator
None 
EnqueuedBundles 
SkippedAlreadyMountedBundles 
SkippedAlreadyUpdatedBundles 
SkippedAlreadyReleasedBundles 
SkippedAlreadyRemovedBundles 
SkippedUnknownBundles 
SkippedInvalidBundles 
SkippedUnusableLanguageBundles 
SkippedBundlesDueToBundleSource 

◆ EInstallBundleResult

enum class EInstallBundleResult : uint32
strong
Enumerator
OK 
FailedPrereqRequiresLatestClient 
FailedPrereqRequiresLatestContent 
FailedCacheReserve 
InstallError 
InstallerOutOfDiskSpaceError 
ManifestArchiveError 
ConnectivityError 
UserCancelledError 
InitializationError 
InitializationPending 
MetadataError 
Count 

◆ EInstallBundleSourceBundleSkipReason

enum class EInstallBundleSourceBundleSkipReason : uint32
strong
Enumerator
None 
LanguageNotCurrent 
NotValid 

◆ EInstallBundleSourceUpdateBundleInfoResult

enum class EInstallBundleSourceUpdateBundleInfoResult : uint8
strong
Enumerator
OK 
NotInitailized 
AlreadyMounted 
AlreadyRequested 
IllegalCacheStatus 
Count 

◆ EInstallBundleStatus

enum class EInstallBundleStatus : int
strong
Enumerator
Requested 
Updating 
Finishing 
Ready 
Count 

Function Documentation

◆ DECLARE_DELEGATE_OneParam()

DECLARE_DELEGATE_OneParam ( FInstallBundleGetContentStateDelegate  ,
FInstallBundleCombinedContentState   
)

◆ ENUM_CLASS_FLAGS() [1/5]

ENUM_CLASS_FLAGS ( EInstallBundleCacheStatsFlags  )

◆ ENUM_CLASS_FLAGS() [2/5]

ENUM_CLASS_FLAGS ( EInstallBundleGetContentStateFlags  )

◆ ENUM_CLASS_FLAGS() [3/5]

ENUM_CLASS_FLAGS ( EInstallBundlePauseFlags  )

◆ ENUM_CLASS_FLAGS() [4/5]

ENUM_CLASS_FLAGS ( EInstallBundleRequestInfoFlags  )

◆ ENUM_CLASS_FLAGS() [5/5]

ENUM_CLASS_FLAGS ( EInstallBundleSourceBundleSkipReason  )

◆ ENUM_RANGE_BY_COUNT()

enum UE_DEPRECATED(5.5, "Use FInstallBundleSourceType") EInstallBundleSourceType PRAGMA_DISABLE_DEPRECATION_WARNINGS ENUM_RANGE_BY_COUNT ( EInstallBundleSourceType  ,
EInstallBundleSourceType::Count   
)
strong

◆ LexFromString()

INSTALLBUNDLEMANAGER_API void LexFromString ( EInstallBundleSourceType &  OutType,
const TCHAR *  String 
)

◆ LexToString() [1/10]

INSTALLBUNDLEMANAGER_API const TCHAR * LexToString ( EInstallBundleInstallState  State)

◆ LexToString() [2/10]

INSTALLBUNDLEMANAGER_API const TCHAR * LexToString ( EInstallBundleManagerInitResult  Result)

◆ LexToString() [3/10]

INSTALLBUNDLEMANAGER_API const TCHAR * LexToString ( EInstallBundleManagerPatchCheckResult  EnumVal)

◆ LexToString() [4/10]

INSTALLBUNDLEMANAGER_API const TCHAR * LexToString ( EInstallBundlePriority  Priority)

◆ LexToString() [5/10]

INSTALLBUNDLEMANAGER_API const TCHAR * LexToString ( EInstallBundleReleaseResult  Result)

◆ LexToString() [6/10]

INSTALLBUNDLEMANAGER_API const TCHAR * LexToString ( EInstallBundleResult  Result)

◆ LexToString() [7/10]

INSTALLBUNDLEMANAGER_API const TCHAR * LexToString ( EInstallBundleSourceType  Type)

◆ LexToString() [8/10]

INSTALLBUNDLEMANAGER_API const TCHAR * LexToString ( EInstallBundleSourceUpdateBundleInfoResult  Result)

◆ LexToString() [9/10]

INSTALLBUNDLEMANAGER_API const TCHAR * LexToString ( EInstallBundleStatus  Status)

◆ LexToString() [10/10]

INSTALLBUNDLEMANAGER_API const TCHAR * LexToString ( FInstallBundleSourceType  Type)

◆ LexTryParseString()

INSTALLBUNDLEMANAGER_API bool LexTryParseString ( EInstallBundlePriority &  OutMode,
const TCHAR *  InBuffer 
)