1. Epic GamesDeveloper
  3. UGameFeaturesSubsystem

UGameFeaturesSubsystem

The manager subsystem for game features

API > API/Plugins > API/Plugins/GameFeatures

Inheritance Hierarchy

  • UEngineSubsystem
  • UGameFeaturesSubsystem

References

   
Module GameFeatures
Header /Engine/Plugins/Runtime/GameFeatures/Source/GameFeatures/Public/GameFeaturesSubsystem.h
Include #include "GameFeaturesSubsystem.h"

Syntax

UCLASS ()  
class UGameFeaturesSubsystem : public UEngineSubsystem

Remarks

The manager subsystem for game features

Functions

  Type Name Description
Public function void

AddObserver ( UObject* Observer
)

  
Public function void

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

  
Public function void

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

  
Public function void

CancelGameFeatureStateChange ( const FString& PluginURL
)

 Attempt to cancel any state change.
Public function void

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

  
Public function void

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

 Changes the target state of a game feature plugin
Public function void

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

  
Public function Static EGameFeaturePluginState  
Public function void

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

  
Public function void

DeactivateGameFeaturePlugin ( const FString& PluginURL
)

 Deactivates the specified plugin
Public function Virtual void  
Public function Static EBuiltInAutoState

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

 Determine the initial feature state for a built-in plugin
Public function Const bool Determines if a plugin is up to date or needs an update. Returns true if an update is available.
Public function Const void

FilterInactivePluginAssets ( TArray< FAssetIdentifier >& AssetsToFilter
)

 Removes assets that are in plugins we know to be inactive. Order is not maintained.
Public function Const void

FilterInactivePluginAssets ( TArray< FAssetData >& AssetsToFilter
)

 Removes assets that are in plugins we know to be inactive. Order is not maintained.
Public function Static void

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

 Fixes a package path/directory to either be relative to plugin root or not.
Public function Const void

ForEachActiveGameFeature ( Func InFunc
)

 Calls the compile-time lambda on each active game feature data of the specified type
Public function Const void  
Public function Const void Calls the compile-time lambda on each registered game feature data of the specified type
Public function Static UGameFeaturesSubsystem &

Get ()

  
Public function Const bool

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

 Gets relevant properties out of a uplugin file. Should only be used for built-in GFPs
Public function Const bool

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

 Gets relevant properties out of a uplugin file. Should only be used for built-in GFPs
Public function Const bool

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

 Gets the URL for the given plugin, applying game-specific policies where appropriate.
Public function const UGameFeatureData * Returns the game feature data for an active plugin specified by PluginURL
Public function void

GetGameFeatureDataForActivePlugins ( TArray< const UGameFeatureData* >& OutActivePluginFeatureDatas
)

 Returns all the active plugins GameFeatureDatas
Public function const UGameFeatureData *

GetGameFeatureDataForRegisteredPluginByURL ( const FString& PluginURL,
bool bCheckForRegistering
)

 Returns the game feature data for a registered plugin specified by PluginURL
Public function Const bool Gets relevant properties out of a uplugin file if it's installed
Public function Const bool

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

 Gets relevant properties out of a uplugin file
Public function Const bool

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

  
Public function Const bool

GetGameFeaturePluginInstallPercent ( const FString& PluginURL,
float& Install_Percent
)

 Gets the Install_Percent for single game feature plugin if it is active.
Public function Const void Returns the list of plugin filenames that have progressed beyond installed.
Public function Const FString Get the plugin path from the plugin URL
Public function Const EGameFeaturePluginState Returns the current state of the state machine for the specified plugin PluginIdentifier
Public function Const EGameFeaturePluginState

GetPluginState ( const FString& PluginURL
)

 Returns the current state of the state machine for the specified plugin URL
Public function Static void

GetPluginsToCook ( TSet< FString >& OutPlugins
)

 Used during a DLC cook to determine which plugins should be cooked
Public function Static FString

GetPluginURL_FileProtocol ( const FString& PluginDescriptorPath
)

 Construct a 'file:' Plugin URL using from the PluginDescriptorPath
Public function Static FString

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

  
Public function Static FString

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

 Construct a 'installbundle:' Plugin URL using from the PluginName and required install bundles
Public function Static FString

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

  
Public function Static FString

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

  
Public function Static FString

GetPluginURL_InstallBundleProtocol ( const FString& PluginName,
FName BundleName
)

  
Public function Static FString

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

  
Public function Const bool

GetPluginURLByName ( FStringView PluginName,
FString& OutPluginURL
)

 If the specified plugin is known by the game feature system, returns the URL used to identify it
Public function Const bool

GetPluginURLForBuiltInPluginByName ( const FString& PluginName,
FString& OutPluginURL
)

 If the specified plugin is a built-in plugin, return the URL used to identify it.
Public function Static EGameFeaturePluginProtocol Returns the plugin protocol for the specified URL
Public function Const T & Returns the game-specific policy for managing game feature plugins
Public function Virtual void

Initialize ( FSubsystemCollectionBase& Collection
)

  
Public function Const bool

IsGameFeaturePluginActive ( const FString& PluginURL,
bool bCheckForActivating
)

 Determines if a plugin is in the Active state.
Public function Const bool

IsGameFeaturePluginInstalled ( const FString& PluginURL
)

 Determines if a plugin is in the Installed state (or beyond)
Public function Const bool

IsGameFeaturePluginLoaded ( const FString& PluginURL
)

 Determines if a plugin is in the Loaded state (or beyond)
Public function Const bool

IsGameFeaturePluginMounted ( const FString& PluginURL
)

 Determines if a plugin is beyond the Mounting state
Public function Const bool

IsGameFeaturePluginRegistered ( const FString& PluginURL,
bool bCheckForRegistering
)

 Determines if a plugin is in the Registered state (or beyond)
Public function Static bool Tests whether the plugin URL is the specified protocol
Public function void

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

  
Public function void

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

 Loads a single game feature plugin and activates it.
Public function void

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

  
Public function void

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

 Loads a built-in game feature plugin if it passes the specified filter
Public function void Loads all built-in game feature plugins that pass the specified filters
Public function Static TSharedPtr< FStreamableHandle >

LoadGameFeatureData ( const FString& GameFeatureToLoad,
bool bStartStalled
)

 Loads the specified game feature data and its bundles
Public function void

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

  
Public function void

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

 Loads a single game feature plugin.
Public function void

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

  
Public function Static bool

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

 Parse the plugin URL into subparts
Public function Static bool

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

  
Public function Static bool

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

  
Public function 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
Public function Static bool

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

  
Public function 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.
Public function void

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

 Registers a single game feature plugin.
Public function void

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

  
Public function void

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

  
Public function void

ReleaseGameFeaturePlugin ( const FString& PluginURL
)

 Releases any game data stored for this GameFeaturePlugin.
Public function void

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

  
Public function void

RemoveObserver ( UObject* Observer
)

  
Public function void

TerminateGameFeaturePlugin ( const FString& PluginURL
)

 Terminate the GameFeaturePlugin and remove all associated plugin tracking data.
Public function void

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

  
Public function void

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

  
Public function void

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

 Uninstalls any game data stored for this GameFeaturePlugin and terminates the GameFeaturePlugin.
Public function Static void

UnloadGameFeatureData ( const UGameFeatureData* GameFeatureToUnload
)

  
Public function void

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

  
Public function void

UnloadGameFeaturePlugin ( const FString& PluginURL,
bool bKeepRegistered
)

 Unloads the specified game feature plugin.
Public function UE::GameFeatures::FResult

UpdateGameFeatureProtocolOptions ( const FString& PluginURL,
const FGameFeatureProtocolOptions& NewOptions,
bool* bOutDidUpdate
)

 Changes the protocol options of a game feature plugin.
Public function Const bool Was this game feature plugin loaded using the LoadBuiltInGameFeaturePlugin path

Enums

  Type Name Description
Private enum EObserverCallback    

Typedefs

Name Description
FBuiltInPluginAdditionalFilters  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page