Navigation
API > API/Runtime > API/Runtime/InstallBundleManager
| Name | IInstallBundleSource |
| Type | class |
| Header File | /Engine/Source/Runtime/InstallBundleManager/Public/InstallBundleSourceInterface.h |
| Include Path | #include "InstallBundleSourceInterface.h" |
Syntax
class IInstallBundleSource : public TSharedFromThis< IInstallBundleSource >
Inheritance Hierarchy
- TSharedFromThis< IInstallBundleSource > → IInstallBundleSource
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IInstallBundleSource() |
InstallBundleSourceInterface.h |
Structs
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EmptyStats | TArray< FBuildInstallerStat > | InstallBundleSourceInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AsyncInit
(
FInstallBundleSourceInitDelegate Callback |
Bundle manager will not call AsyncInit again until the bundle source calls back that it is complete It will be retried indefinitely until init is successful. | InstallBundleSourceInterface.h | |
void AsyncInit_QueryBundleInfo
(
FInstallBundleSourceQueryBundleInfoDelegate OnCompleteCallback |
Currently only called after AsyncInit initialization. | InstallBundleSourceInterface.h | |
virtual void AsyncInit_SetUpdateBundleInfoCallback
(
FInstallBundleSourceUpdateBundleInfoDelegate UpdateCallback, |
Sets callbacks to Install Bundle Manager for dynamically discovered bundles UpdateCallback - Call to add or update bundle info from this source. | InstallBundleSourceInterface.h | |
virtual void CancelBundles
(
TArrayView< const FName > BundleNames |
Cancel the install for the specified bundles. | InstallBundleSourceInterface.h | |
virtual void CancelBundles
(
TArrayView< const FName > BundleNames, |
InstallBundleSourceInterface.h | ||
virtual bool CancelRequestRemoveContentOnNextInit
(
TArrayView< const FName > BundleNames |
Call to cancel the removal of any content scheduled for removal the next time the source is initialized Returns true if all bundles were canceled | InstallBundleSourceInterface.h | |
virtual void CheckForContentPatch
(
FInstallBundleSourceContentPatchResultDelegate Callback |
InstallBundleSourceInterface.h | ||
TSet< FName > GetBundleDependencies
(
FName InBundleName, |
Finds all dependencies for InBundleName, including InBundleName SkippedUnknownBundles contains any unknown bundles that may have been found | InstallBundleSourceInterface.h | |
virtual TOptional< FInstallBundleSourceProgress > GetBundleProgress
(
FName BundleName |
Derived classes should implement this if their content install will take a significant amount of time. | InstallBundleSourceInterface.h | |
virtual EInstallBundleSourceBundleSkipReason GetBundleSkipReason
(
FName BundleName |
Allows this bundle source to reject bundle requests early, rather than failing them. | InstallBundleSourceInterface.h | |
virtual TArray< FBuildInstallerStat > & GetBundleUpdateStats
(
FName BundleName |
Override to return information about a bundle installer. | InstallBundleSourceInterface.h | |
void GetContentState
(
TArrayView< const FName > BundleNames, |
Gets the state of content on disk BundleNames contains all dependencies and has been deduped | InstallBundleSourceInterface.h | |
FString GetContentVersion() |
Returns content version in a " |
InstallBundleSourceInterface.h | |
virtual void GetDebugText
(
TArray< FString >& Output |
InstallBundleSourceInterface.h | ||
EInstallBundleManagerInitState GetInitState() |
Whether this source has been initialized or not. | InstallBundleSourceInterface.h | |
virtual EInstallBundleRequestFlags GetModifyableContentRequestFlags() |
UpdateContentRequestFlags - Allow some flags to be updated for in flight requests Currently only CheckForCellularDataUsage is supported | InstallBundleSourceInterface.h | |
virtual TArray< FName > GetRequestedRemoveContentOnNextInit() |
Returns the bundle names of any content that is currently removal the next time the source is initialized. | InstallBundleSourceInterface.h | |
virtual double GetSourceCacheAgeScalar() |
Returns a value in the [0.1, 1.0] range that allows bundles using this source to age out of the LRU cache more slowly. | InstallBundleSourceInterface.h | |
FInstallBundleSourceType GetSourceType() |
Returns a unique id for this source. | InstallBundleSourceInterface.h | |
virtual float GetSourceWeight() |
Returns the how this source should be weighted when combined with other sources. | InstallBundleSourceInterface.h | |
FInstallBundleSourceInitInfo Init
(
TSharedRef< InstallBundleUtil::FContentRequestStatsMap > InRequestStats, |
Called once by bundle manager after constructing the bundle source Any non-fallback errors returned will cause bundle manager to fail to initialize | InstallBundleSourceInterface.h | |
virtual void OnBundleInfoPruned
(
FName InBundleName |
InstallBundleSourceInterface.h | ||
virtual void RequestReleaseContent
(
FRequestReleaseContentBundleContext BundleContext |
Notify bundle source that a bundle has been released If EInstallBundleReleaseRequestFlags::RemoveFilesIfPossible is set, the source should remove content from disk if present The source should set bContentWasRemoved to indicate to bundle manager that the bundle content was uninstalled BundleContexts contains all dependencies and has been deduped Bundle manager will not schedule removes at the same time as updates for the same bundle | InstallBundleSourceInterface.h | |
virtual bool RequestRemoveContentOnNextInit
(
TArrayView< const FName > RemoveNames |
Returns true if content is scheduled to be removed the next time the source is initialized BundleNames contains all dependencies and has been deduped | InstallBundleSourceInterface.h | |
void RequestUpdateContent
(
FRequestUpdateContentBundleContext BundleContext |
Updates content on disk if necessary BundleContexts contains all dependencies and has been deduped | InstallBundleSourceInterface.h | |
virtual void SetBundleRequestCompletedDelegate
(
FInstallBundleRequestCompletedDelegate Delegate |
InstallBundleSourceInterface.h | ||
virtual void SetBundleRequestStartedDelegate
(
FInstallBundleRequestStartedDelegate Delegate |
InstallBundleSourceInterface.h | ||
virtual void SetCellularPreference
(
int32 Value |
InstallBundleSourceInterface.h | ||
virtual void SetErrorSimulationCommands
(
const FString& CommandLine |
Called by bundle manager to pass through command line options to simulate errors. | InstallBundleSourceInterface.h | |
virtual void SetReportingDelegate
(
FInstallBundleReportingDelegate Delegate |
InstallBundleSourceInterface.h | ||
virtual bool SupportsBundleRequestEventDelegates() |
InstallBundleSourceInterface.h | ||
virtual bool SupportsReportingDelegate() |
InstallBundleSourceInterface.h | ||
virtual void UpdateContentRequestFlags
(
TArrayView< const FName > BundleNames, |
InstallBundleSourceInterface.h | ||
virtual void UserPauseBundles
(
TArrayView< const FName > BundleNames |
User Pause/Resume bundles. | InstallBundleSourceInterface.h | |
virtual void UserResumeBundles
(
TArrayView< const FName > BundleNames |
InstallBundleSourceInterface.h |