Navigation
API > API/Runtime > API/Runtime/InstallBundleManager
Inheritance Hierarchy
- TSharedFromThis
- IInstallBundleSource
- FInstallBundleSourceBulk
References
| Module | InstallBundleManager |
| Header | /Engine/Source/Runtime/InstallBundleManager/Public/InstallBundleSourceInterface.h |
| Include | #include "InstallBundleSourceInterface.h" |
Syntax
class IInstallBundleSource : public TSharedFromThis< IInstallBundleSource >
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| 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. | |
| void | AsyncInit_QueryBundleInfo
(
FInstallBundleSourceQueryBundleInfoDelegate OnCompleteCallback |
Currently only called after AsyncInit initialization. | |
| 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. | |
| void | CancelBundles
(
TArrayView< const FName > BundleNames |
Cancel the install for the specified bundles. | |
| 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 | |
| void | CheckForContentPatch
(
FInstallBundleSourceContentPatchResultDelegate Callback |
||
| TSet< FName > | GetBundleDependencies
(
FName InBundleName, |
Finds all dependencies for InBundleName, including InBundleName SkippedUnknownBundles contains any unknown bundles that may have been found | |
| TOptional< FInstallBundleSourceProgress > | GetBundleProgress
(
FName BundleName |
Derived classes should implement this if their content install will take a significant amount of time. | |
| EInstallBundleSourceBundleSkipReason | GetBundleSkipReason
(
FName BundleName |
Allows this bundle source to reject bundle requests early, rather than failing them. | |
| void | GetContentState
(
TArrayView< const FName > BundleNames, |
Gets the state of content on disk BundleNames contains all dependencies and has been deduped | |
| FString | Returns content version in a " |
||
| EInstallBundleManagerInitState | GetInitState () |
Whether this source has been initialized or not. | |
| EInstallBundleRequestFlags | UpdateContentRequestFlags - Allow some flags to be updated for in flight requests Currently only CheckForCellularDataUsage is supported | ||
| double | 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. | ||
| EInstallBundleSourceType | Returns a unique id for this source. | ||
| float | Returns the how this source should be weighted when combined with other sources. | ||
| 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 | |
| void | OnBundleInfoPruned
(
FName InBundleName |
||
| 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 | |
| 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 | |
| void | RequestUpdateContent
(
FRequestUpdateContentBundleContext BundleContext |
Updates content on disk if necessary BundleContexts contains all dependencies and has been deduped | |
| void | SetErrorSimulationCommands
(
const FString& CommandLine |
Called by bundle manager to pass through command line options to simulate errors. | |
| void | UpdateContentRequestFlags
(
TArrayView< const FName > BundleNames, |
||
| void | UserPauseBundles
(
TArrayView< const FName > BundleNames |
User Pause/Resume bundles. | |
| void | UserResumeBundles
(
TArrayView< const FName > BundleNames |
Classes
| Type | Name | Description | |
|---|---|---|---|
| FRequestReleaseContentBundleContext | |||
| FRequestUpdateContentBundleContext |