1. Epic GamesDeveloper
  3. UGameFeaturesSubsystem

UGameFeaturesSubsystem

The manager subsystem for game features

API > API/Plugins > API/Plugins/GameFeatures

The manager subsystem for game features

   
Name UGameFeaturesSubsystem
Type class
Header File /Engine/Plugins/Runtime/GameFeatures/Source/GameFeatures/Public/GameFeaturesSubsystem.h
Include Path #include "GameFeaturesSubsystem.h"

Syntax

UCLASS (MinimalAPI)  
class UGameFeaturesSubsystem : public UEngineSubsystem

Inheritance Hierarchy

Structs

Name Remarks
FCachedGameFeaturePluginDetails  
FGameFeatureBatchProcessingFence Active fences

Typedefs

Name Type Remarks Include Path
FBuiltInPluginAdditionalFilters TFunctionRef< bool(const FString &PluginFilename, const FGameFeaturePluginDetails &Details, FBuiltInGameFeaturePluginBehaviorOptions &OutOptions)>   GameFeaturesSubsystem.h
FBuiltInPluginAdditionalFilters_Copyable TFunction< bool(const FString &PluginFilename, const FGameFeaturePluginDetails &Details, FBuiltInGameFeaturePluginBehaviorOptions &OutOptions)>   GameFeaturesSubsystem.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BatchProcessingFences TMap< EGameFeaturePluginState, FGameFeatureBatchProcessingFence >   GameFeaturesSubsystem.h  
bInitializedPolicyManager bool   GameFeaturesSubsystem.h  
CachedGameFeaturePluginDetailsLock FTransactionallySafeRWLock   GameFeaturesSubsystem.h  
CachedPluginDetailsByFilename TMap< FString, FCachedGameFeaturePluginDetails >   GameFeaturesSubsystem.h  
DebugStateChangedForPlugins TSet< FString >   GameFeaturesSubsystem.h  
GameFeaturePluginNameToPathMap TMap< FString, FString >   GameFeaturesSubsystem.h  
GameFeaturePluginStateMachines TMap< FString, TObjectPtr< UGameFeaturePluginStateMachine > > The list of all game feature plugin state machine objects GameFeaturesSubsystem.h
  • Transient
GameSpecificPolicies TObjectPtr< UGameFeaturesProjectPolicies >   GameFeaturesSubsystem.h
  • Transient
GetExplanationForUnavailablePackageDelegateHandle FDelegateHandle   GameFeaturesSubsystem.h  
Observers TArray< TObjectPtr< UObject > >   GameFeaturesSubsystem.h  
OnPluginUnmountedDelegateHandle FDelegateHandle   GameFeaturesSubsystem.h  
RunningStateMachines TArray< UGameFeaturePluginStateMachine * > State machine currently in transition, used to limit search space when checking a batch processing fence or similar GameFeaturesSubsystem.h  
TerminalGameFeaturePluginStateMachines TArray< TObjectPtr< UGameFeaturePluginStateMachine > > Game feature plugin state machine objects that are being terminated. GameFeaturesSubsystem.h
  • Transient
TickHandle FTSTicker::FDelegateHandle The tick handle if currently registered for a tick GameFeaturesSubsystem.h  
UnmountedPluginNameToExplanation TMap< FString, FString > When we decide not to mount a plugin, we can store an explanation here so that if we later attempt to load an asset from it we can tell the user why it's not available. GameFeaturesSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddObserver ( UObject* Observer
)

   GameFeaturesSubsystem.h  

void CancelGameFeatureStateChange ( TConstArrayView< FString > PluginURLs,
const FMultipleGameFeaturePluginChangeStateComplete& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void CancelGameFeatureStateChange ( const FString& PluginURL,
const FGameFeaturePluginChangeStateComplete& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void CancelGameFeatureStateChange ( const FString& PluginURL
)

 Attempt to cancel any state change. GameFeaturesSubsystem.h  

void ChangeGameFeatureTargetState ( const FString& PluginURL,
EGameFeatureTargetState TargetState,
const FGameFeaturePluginChangeStateComplete& CompleteDelegate
)

 Changes the target state of a game feature plugin GameFeaturesSubsystem.h  

void ChangeGameFeatureTargetState ( TConstArrayView< FString > PluginURLs,
const FGameFeatureProtocolOptions& ProtocolOptions,
EGameFeatureTargetState TargetState,
const FMultipleGameFeaturePluginsLoaded& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void ChangeGameFeatureTargetState ( const FString& PluginURL,
const FGameFeatureProtocolOptions& ProtocolOptions,
EGameFeatureTargetState TargetState,
const FGameFeaturePluginChangeStateComplete& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void DeactivateGameFeaturePlugin ( const FString& PluginURL
)

 Deactivates the specified plugin GameFeaturesSubsystem.h  

void DeactivateGameFeaturePlugin ( const FString& PluginURL,
const FGameFeaturePluginDeactivateComplete& CompleteDelegate
)

   GameFeaturesSubsystem.h  

bool DoesGameFeaturePluginNeedUpdate ( const FString& PluginURL
) const

 Determines if a plugin is up to date or needs an update. Returns true if an update is available. GameFeaturesSubsystem.h  

void FilterInactivePluginAssets ( TArray< FAssetIdentifier >& AssetsToFilter
) const

 Removes assets that are in plugins we know to be inactive. Order is not maintained. GameFeaturesSubsystem.h  

void FilterInactivePluginAssets ( TArray< FAssetData >& AssetsToFilter
) const

 Removes assets that are in plugins we know to be inactive. Order is not maintained. GameFeaturesSubsystem.h  

void ForEachActiveGameFeature ( Func InFunc
) const

 Calls the compile-time lambda on each active game feature data of the specified type GameFeaturesSubsystem.h  

void ForEachGameFeature ( TFunctionRef< void(FGameFeatureInfo&&)> Visitor
) const

   GameFeaturesSubsystem.h  

void ForEachRegisteredGameFeature ( Func InFunc
) const

 Calls the compile-time lambda on each registered game feature data of the specified type GameFeaturesSubsystem.h  

bool GetBuiltInGameFeaturePluginDetails ( const TSharedRef< IPlugin >& Plugin,
FGameFeaturePluginDetails& OutPluginDetails
) const

 Gets relevant properties out of a uplugin file. Should only be used for built-in GFPs GameFeaturesSubsystem.h  

bool GetBuiltInGameFeaturePluginDetails ( const TSharedRef< IPlugin >& Plugin,
FString& OutPluginURL,
FGameFeaturePluginDetails& OutPluginDetails
) const

 Gets relevant properties out of a uplugin file. Should only be used for built-in GFPs GameFeaturesSubsystem.h  

bool GetBuiltInGameFeaturePluginURL ( const TSharedRef< IPlugin >& Plugin,
FString& OutPluginURL
) const

 Gets the URL for the given plugin, applying game-specific policies where appropriate. GameFeaturesSubsystem.h  

bool GetGameFeatureControlsUPlugin ( const FString& PluginURL,
bool& OutGameFeatureControlsUPlugin
) const

 Sets OutGameFeatureControlsUPlugin to true if the uplugin was added by a GFP as opposed to existing independent of the GFP subsystem. GameFeaturesSubsystem.h  

const UGameFeatureData * GetGameFeatureDataForActivePluginByURL ( const FString& PluginURL
)

 Returns the game feature data for an active plugin specified by PluginURL GameFeaturesSubsystem.h  

void GetGameFeatureDataForActivePlugins ( TArray< const UGameFeatureData* >& OutActivePluginFeatureDatas
)

 Returns all the active plugins GameFeatureDatas GameFeaturesSubsystem.h  

const UGameFeatureData * GetGameFeatureDataForRegisteredPluginByURL ( const FString& PluginURL,
bool bCheckForRegistering
)

 Returns the game feature data for a registered plugin specified by PluginURL GameFeaturesSubsystem.h  

bool GetGameFeaturePluginDetails ( const TSharedRef< IPlugin >& Plugin,
FString& OutPluginURL,
FGameFeaturePluginDetails& OutPluginDetails
) const

 Gets relevant properties out of a uplugin file GameFeaturesSubsystem.h  

bool GetGameFeaturePluginDetails ( const FString& PluginURL,
FGameFeaturePluginDetails& OutPluginDetails
) const

 Gets relevant properties out of a uplugin file if it's installed GameFeaturesSubsystem.h  

bool GetGameFeaturePluginInstallPercent ( TConstArrayView< FString > PluginURLs,
float& Install_Percent
) const

   GameFeaturesSubsystem.h  

bool GetGameFeaturePluginInstallPercent ( const FString& PluginURL,
float& Install_Percent
) const

 Gets the Install_Percent for single game feature plugin if it is active. GameFeaturesSubsystem.h  

void GetLoadedGameFeaturePluginFilenamesForCooking ( TArray< FString >& OutLoadedPluginFilenames
) const

 Returns the list of plugin filenames that have progressed beyond installed. GameFeaturesSubsystem.h  

bool GetPluginDebugStateEnabled ( const FString& PluginUrl
)

   GameFeaturesSubsystem.h  

FString GetPluginFilenameFromPluginURL ( const FString& PluginURL
) const

 Get the plugin path from the plugin URL GameFeaturesSubsystem.h  

EGameFeaturePluginState GetPluginState ( const FString& PluginURL
) const

 Returns the current state of the state machine for the specified plugin URL GameFeaturesSubsystem.h  
Returns the current state of the state machine for the specified plugin PluginIdentifier GameFeaturesSubsystem.h  

bool GetPluginURLByName ( FStringView PluginName,
FString& OutPluginURL
) const

 If the specified plugin is known by the game feature system, returns the URL used to identify it GameFeaturesSubsystem.h  

bool GetPluginURLForBuiltInPluginByName ( const FString& PluginName,
FString& OutPluginURL
) const

 If the specified plugin is a built-in plugin, return the URL used to identify it. GameFeaturesSubsystem.h  

T & GetPolicy()

 Returns the game-specific policy for managing game feature plugins GameFeaturesSubsystem.h  

bool IsGameFeaturePluginActive ( const FString& PluginURL,
bool bCheckForActivating
) const

 Determines if a plugin is in the Active state. GameFeaturesSubsystem.h  

bool IsGameFeaturePluginInstalled ( const FString& PluginURL
) const

 Determines if a plugin is in the Installed state (or beyond) GameFeaturesSubsystem.h  

bool IsGameFeaturePluginLoaded ( const FString& PluginURL
) const

 Determines if a plugin is in the Loaded state (or beyond) GameFeaturesSubsystem.h  

bool IsGameFeaturePluginMounted ( const FString& PluginURL
) const

 Determines if a plugin is beyond the Mounting state GameFeaturesSubsystem.h  

bool IsGameFeaturePluginRegistered ( const FString& PluginURL,
bool bCheckForRegistering
) const

 Determines if a plugin is in the Registered state (or beyond) GameFeaturesSubsystem.h  

void LoadAndActivateGameFeaturePlugin ( TConstArrayView< FString > PluginURLs,
const FGameFeatureProtocolOptions& ProtocolOptions,
const FMultipleGameFeaturePluginsLoaded& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void LoadAndActivateGameFeaturePlugin ( const FString& PluginURL,
const FGameFeatureProtocolOptions& ProtocolOptions,
const FGameFeaturePluginLoadComplete& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void LoadAndActivateGameFeaturePlugin ( const FString& PluginURL,
const FGameFeaturePluginLoadComplete& CompleteDelegate
)

 Loads a single game feature plugin and activates it. GameFeaturesSubsystem.h  

void LoadBuiltInGameFeaturePlugin ( const TSharedRef< IPlugin >& Plugin,
FBuiltInPluginAdditionalFilters AdditionalFilter,
const FGameFeaturePluginLoadComplete& CompleteDelegate
)

 Loads a built-in game feature plugin if it passes the specified filter GameFeaturesSubsystem.h  

void LoadBuiltInGameFeaturePlugins ( FBuiltInPluginAdditionalFilters AdditionalFilter,
const FBuiltInGameFeaturePluginsLoaded& CompleteDelegate
)

 Loads all built-in game feature plugins that pass the specified filters GameFeaturesSubsystem.h  

void LoadBuiltInGameFeaturePlugins_Amortized ( const FBuiltInPluginAdditionalFilters_Copyable& AdditionalFilter_Copyable,
int32 AmortizeRate,
const FBuiltInGameFeaturePluginsLoaded& CompleteDelegate
)

 Loads all built-in game feature plugins that pass the specified filters, split over multiple frames processing only AmortizeRate plugins per frame if greater than 0. GameFeaturesSubsystem.h  

void LoadGameFeaturePlugin ( TConstArrayView< FString > PluginURLs,
const FGameFeatureProtocolOptions& ProtocolOptions,
const FMultipleGameFeaturePluginsLoaded& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void LoadGameFeaturePlugin ( const FString& PluginURL,
const FGameFeatureProtocolOptions& ProtocolOptions,
const FGameFeaturePluginLoadComplete& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void LoadGameFeaturePlugin ( const FString& PluginURL,
const FGameFeaturePluginLoadComplete& CompleteDelegate
)

 Loads a single game feature plugin. GameFeaturesSubsystem.h  

TSharedRef< FGameFeaturePluginPredownloadHandle > PredownloadGameFeaturePlugins ( TConstArrayView< FString > PluginURLs,
TUniqueFunction< void(const UE::GameFeatures::FResult&)> OnComplete,
TUniqueFunction< void(float)> OnProgress
)

 Pre-install any required game feature data, which can be useful for larger payloads. GameFeaturesSubsystem.h  

void RegisterGameFeaturePlugin ( const FString& PluginURL,
const FGameFeaturePluginLoadComplete& CompleteDelegate
)

 Registers a single game feature plugin. GameFeaturesSubsystem.h  

void RegisterGameFeaturePlugin ( const FString& PluginURL,
const FGameFeatureProtocolOptions& ProtocolOptions,
const FGameFeaturePluginLoadComplete& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void RegisterGameFeaturePlugin ( TConstArrayView< FString > PluginURLs,
const FGameFeatureProtocolOptions& ProtocolOptions,
const FMultipleGameFeaturePluginsLoaded& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void ReleaseGameFeaturePlugin ( const FString& PluginURL,
const FGameFeaturePluginReleaseComplete& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void ReleaseGameFeaturePlugin ( const FString& PluginURL
)

 Releases any game data stored for this GameFeaturePlugin. GameFeaturesSubsystem.h  

void RemoveObserver ( UObject* Observer
)

   GameFeaturesSubsystem.h  

void SetPluginDebugStateEnabled ( const FString& PluginUrl,
bool bEnabled
)

   GameFeaturesSubsystem.h  

void TerminateGameFeaturePlugin ( const FString& PluginURL,
const FGameFeaturePluginTerminateComplete& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void TerminateGameFeaturePlugin ( const FString& PluginURL
)

 Terminate the GameFeaturePlugin and remove all associated plugin tracking data. GameFeaturesSubsystem.h  

void TerminateGameFeaturePlugin ( TConstArrayView< FString > PluginURLs,
const FMultipleGameFeaturePluginsTerminated& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void UninstallGameFeaturePlugin ( const FString& PluginURL,
const FGameFeaturePluginUninstallComplete& CompleteDelegate
)

 Uninstalls any game data stored for this GameFeaturePlugin and terminates the GameFeaturePlugin. GameFeaturesSubsystem.h  

void UninstallGameFeaturePlugin ( const FString& PluginURL,
const FGameFeatureProtocolOptions& ProtocolOptions,
const FGameFeaturePluginUninstallComplete& CompleteDelegate
)

   GameFeaturesSubsystem.h  

void UnloadGameFeaturePlugin ( const FString& PluginURL,
bool bKeepRegistered
)

 Unloads the specified game feature plugin. GameFeaturesSubsystem.h  

void UnloadGameFeaturePlugin ( const FString& PluginURL,
const FGameFeaturePluginUnloadComplete& CompleteDelegate,
bool bKeepRegistered
)

   GameFeaturesSubsystem.h  

UE::GameFeatures::FResult UpdateGameFeatureProtocolOptions ( const FString& PluginURL,
const FGameFeatureProtocolOptions& NewOptions,
bool* bOutDidUpdate
)

 Changes the protocol options of a game feature plugin. GameFeaturesSubsystem.h  

bool WasGameFeaturePluginLoadedAsBuiltIn ( const FString& PluginURL
) const

 Was this game feature plugin loaded using the LoadBuiltInGameFeaturePlugin path GameFeaturesSubsystem.h  

Overridden from USubsystem

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

   GameFeaturesSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   GameFeaturesSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddGameFeatureToAssetManager ( const UGameFeatureData* GameFeatureToAdd,
const FString& PluginName,
TArray< FName >& OutNewPrimaryAssetTypes
)

 Scans for assets specified in the game feature data GameFeaturesSubsystem.h  

static EGameFeaturePluginState ConvertInitialFeatureStateToTargetState ( EBuiltInAutoState InitialState
)

   GameFeaturesSubsystem.h  

static EBuiltInAutoState DetermineBuiltInInitialFeatureState ( TSharedPtr< FJsonObject > Descriptor,
const FString& ErrorContext
)

 Determine the initial feature state for a built-in plugin GameFeaturesSubsystem.h  

static void FixPluginPackagePath ( FString& PathToFix,
const FString& PluginRootPath,
bool bMakeRelativeToPluginRoot
)

 Fixes a package path/directory to either be relative to plugin root or not. GameFeaturesSubsystem.h  

static UGameFeaturesSubsystem & Get()

   GameFeaturesSubsystem.h  

static void GetPluginsToCook ( TSet< FString >& OutPlugins
)

 Used during a DLC cook to determine which plugins should be cooked GameFeaturesSubsystem.h  

static FString GetPluginURL_FileProtocol ( const FString& PluginDescriptorPath,
TArrayView< const TPair< FString, FString > > AdditionalOptions
)

   GameFeaturesSubsystem.h  

static FString GetPluginURL_FileProtocol ( const FString& PluginDescriptorPath
)

 Construct a 'file:' Plugin URL using from the PluginDescriptorPath GameFeaturesSubsystem.h  

static FString GetPluginURL_InstallBundleProtocol ( const FString& PluginName,
TArrayView< const FString > BundleNames
)

 Construct a 'installbundle:' Plugin URL using from the PluginName and required install bundles GameFeaturesSubsystem.h  

static FString GetPluginURL_InstallBundleProtocol ( const FString& PluginName,
const FString& BundleName
)

   GameFeaturesSubsystem.h  

static FString GetPluginURL_InstallBundleProtocol ( const FString& PluginName,
TArrayView< const FName > BundleNames
)

   GameFeaturesSubsystem.h  

static FString GetPluginURL_InstallBundleProtocol ( const FString& PluginName,
FName BundleName
)

   GameFeaturesSubsystem.h  

static FString GetPluginURL_InstallBundleProtocol ( const FString& PluginName,
TArrayView< const FName > BundleNames,
TArrayView< const TPair< FString, FString > > AdditionalOptions
)

   GameFeaturesSubsystem.h  

static EGameFeaturePluginProtocol GetPluginURLProtocol ( FStringView PluginURL
)

 Returns the plugin protocol for the specified URL GameFeaturesSubsystem.h  

static bool IsPluginURLProtocol ( FStringView PluginURL,
EGameFeaturePluginProtocol PluginProtocol
)

 Tests whether the plugin URL is the specified protocol GameFeaturesSubsystem.h  

static TSharedPtr< FStreamableHandle > LoadGameFeatureData ( const FString& GameFeatureToLoad,
bool bStartStalled
)

 Loads the specified game feature data and its bundles GameFeaturesSubsystem.h  

static bool ParsePluginURL ( FStringView PluginURL,
EGameFeaturePluginProtocol* OutProtocol,
FStringView* OutPath,
FStringView* OutOptions
)

 Parse the plugin URL into subparts GameFeaturesSubsystem.h  

static bool ParsePluginURLOptions ( FStringView URLOptionsString,
EGameFeatureURLOptions OptionsFlags,
TConstArrayView< FStringView > AdditionalOptions,
TFunctionRef< void(EGameFeatureURLOptions Option, FStringView OptionString, FStringView OptionValue)...
)

   GameFeaturesSubsystem.h  

static bool ParsePluginURLOptions ( FStringView URLOptionsString,
TConstArrayView< FStringView > AdditionalOptions,
TFunctionRef< void(EGameFeatureURLOptions Option, FStringView OptionString, FStringView OptionValue)...
)

   GameFeaturesSubsystem.h  

static bool ParsePluginURLOptions ( FStringView URLOptionsString,
EGameFeatureURLOptions OptionsFlags,
TFunctionRef< void(EGameFeatureURLOptions Option, FStringView OptionString, FStringView OptionValue)...
)

   GameFeaturesSubsystem.h  

static bool ParsePluginURLOptions ( FStringView URLOptionsString,
TFunctionRef< void(EGameFeatureURLOptions Option, FStringView OptionString, FStringView OptionValue)...
)

 Parse options from a plugin URL or the options subpart of the plugin URL GameFeaturesSubsystem.h  

static void RemoveGameFeatureFromAssetManager ( const UGameFeatureData* GameFeatureToRemove,
const FString& PluginName,
const TArray< FName >& AddedPrimaryAssetTypes
)

   GameFeaturesSubsystem.h  

static void UnloadGameFeatureData ( const UGameFeatureData* GameFeatureToUnload
)

   GameFeaturesSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page