Navigation
API > API/Plugins > API/Plugins/GameFeatures
Utilty class to install GFP optional paks (usually containing optional mips) in sync with GFP content installs. NOTE: This only currently supports LRU cached install bundles. It would need UI callbacks and additional support for free space checks and progress tracking to fully support non-LRU GFPs.
| Name | UGameFeatureOptionalContentInstaller |
| Type | class |
| Header File | /Engine/Plugins/Runtime/GameFeatures/Source/GameFeatures/Public/GameFeatureOptionalContentInstaller.h |
| Include Path | #include "GameFeatureOptionalContentInstaller.h" |
Syntax
UCLASS (MinimalAPI)
class UGameFeatureOptionalContentInstaller :
public UObject ,
public IGameFeatureStateChangeObserver
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGameFeatureOptionalContentInstaller
Implements Interfaces
Structs
| Name | Remarks |
|---|---|
| FGFPInstall |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| GFOContentRequestName | const FName | GameFeatureOptionalContentInstaller.h | |
| OnOptionalContentInstalled | TMulticastDelegate< void(const FString &PluginName, const UE::GameFeatures::FResult &)> | GameFeatureOptionalContentInstaller.h | |
| OnOptionalContentInstallFinished | TMulticastDelegate< void(const bool bInstallSuccessful)> | GameFeatureOptionalContentInstaller.h | |
| OnOptionalContentInstallStarted | TMulticastDelegate< void()> | GameFeatureOptionalContentInstaller.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveGFPInstalls | TMap< FString, FGFPInstall > | GameFeatureOptionalContentInstaller.h | ||
| bAllowCellDownload | bool | GameFeatureOptionalContentInstaller.h | ||
| bEnabled | bool | GameFeatureOptionalContentInstaller.h | ||
| bEnabledCVar | bool | GameFeatureOptionalContentInstaller.h | ||
| BundleManager | TSharedPtr< IInstallBundleManager > | GameFeatureOptionalContentInstaller.h | ||
| CVarSinkHandle | FConsoleVariableSinkHandle | Delegate handle for a console variable sink | GameFeatureOptionalContentInstaller.h | |
| GetOptionalBundlePredicate | TUniqueFunction< TArray< FName >(FString)> | GameFeatureOptionalContentInstaller.h | ||
| RelevantGFPs | TSet< FString > | GameFeatureOptionalContentInstaller.h | ||
| TotalProgressTracker | TOptional< FInstallBundleCombinedProgressTracker > | GameFeatureOptionalContentInstaller.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Enable
(
bool bEnable |
GameFeatureOptionalContentInstaller.h | ||
void EnableCellularDownloading
(
bool bEnable |
GameFeatureOptionalContentInstaller.h | ||
float GetAllInstallsProgress () |
Returns the total progress (between 0 and 1) of all the optional bundles currently being installed. | GameFeatureOptionalContentInstaller.h | |
bool HasOngoingInstalls() |
GameFeatureOptionalContentInstaller.h | ||
void Init
(
TUniqueFunction< TArray< FName >(FString)> GetOptionalBundlePredicate |
GameFeatureOptionalContentInstaller.h | ||
void UninstallContent() |
GameFeatureOptionalContentInstaller.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
GameFeatureOptionalContentInstaller.h |