GameFeatures

API > API/Plugins

   
Name GameFeatures
Type Runtime
Part of Plugins Game Features
Location /Engine/Plugins/Runtime/GameFeatures/Source/GameFeatures/
Module Build Rules GameFeatures.Build.cs

Classes

Name Remarks
FDepthFirstGameFeatureSorter Finds plugin dependencies and returns them in dependency order (reverse topological sort order)
FGameFeatureDataExternalAssetsPathCache  
FGameFeatureStateHandle Public class keep track of ownership and reference counts on which plugins + depends through a public GUID Used internally to reference a structure containing this data You must call the InitAndRegister function this to Properly create a version of this so it is registered internally, otherwise it is invalid to use this
FGameFeatureStateHandleReferenceController  
UDefaultGameFeaturesProjectPolicies This is a default implementation that immediately processes all game feature plugins the based on their BuiltInAutoRegister, BuiltInAutoLoad, and BuiltInAutoActivate settings.
UGameFeatureAction Represents an action to be taken when a game feature is activated
UGameFeatureAction_AddActorFactory GameFeatureAction to add an actor factory when this plugin registers.
UGameFeatureAction_AddCheats Adds cheat manager extensions to the cheat manager for each player
UGameFeatureAction_AddChunkOverride Used to cook assets from a GFP into a specified chunkId.
UGameFeatureAction_AddComponents Adds actor<->component spawn requests to the component manager
UGameFeatureAction_AddWorldPartitionContent  
UGameFeatureAction_AddWPContent  
UGameFeatureAction_AudioActionBase Base class for GameFeatureActions that affect the audio engine
UGameFeatureAction_DataRegistry Specifies a list of Data Registries to load and initialize with this feature
UGameFeatureAction_DataRegistrySource Specifies a list of source assets to add to Data Registries when this feature is activated
UGameFeatureData Data related to a game feature, a collection of code and content that adds a separable discrete feature to the game
UGameFeatureOptionalContentInstaller Utilty class to install GFP optional paks (usually containing optional mips) in sync with GFP content installs.
UGameFeaturesProjectPolicies This class allows project-specific rules to be implemented for game feature plugins.
UGameFeaturesSubsystem The manager subsystem for game features
UGameFeaturesSubsystemSettings Settings for the Game Features framework
UGameFeatureStateChangeObserver  
UGameFeatureVersePathMapperCommandlet  
UIrisFilterGameFeatureAction  

Structs

Name Remarks
FBuiltInGameFeaturePluginBehaviorOptions  
FCaseSensitiveKeyMapFuncs Case sensitive hashing function for TMap
FDataRegistrySourceToAdd Defines which source assets to add and conditions for adding
FDLCInfo  
FGameFeatureActivatingContext Context that provides extra information for activating a game feature
FGameFeatureComponentEntry Description of a component to add to a type of actor when this game feature is enabled (the actor class must be game feature aware, it does not happen magically)
FGameFeatureDeactivatingContext Context that provides extra information for deactivating a game feature, will use the same change context rules as the activating context
FGameFeatureInfo Some important information about a gamefeature
FGameFeaturePauseStateChangeContext Context that provides extra information for a game feature changing its pause state
FGameFeaturePluginAsyncHandle  
FGameFeaturePluginDetails  
FGameFeaturePluginIdentifier Struct used to transform a GameFeaturePlugin URL into something that can uniquely identify the GameFeaturePlugin without including any transient data being passed in through the URL
FGameFeaturePluginInfo  
FGameFeaturePluginPredownloadHandle Handle to track a GFP predownload
FGameFeaturePluginReferenceDetails  
FGameFeaturePostMountingContext Context that allows pausing prior to transitioning out of the mounting state
FGameFeaturePreMountingContext Context that provides extra information prior to mounting a plugin
FGameFeatureProtocolOptions  
FGameFeatureStateChangeContext Struct that determines if game feature action state changes should be applied for cases where there are multiple worlds or contexts.
FGameFeatureVersePathLookup  
FInstallBundlePluginProtocolOptions  
FPluginDependencyDetails  
FResult Struct wrapper on a combined TValueOrError ErrorCode and FText OptionalErrorText that can provide an FString error code and if set more detailed FText OptionalErrorText information for the results of a GameFeaturesPlugin operation.

Interfaces

Name Remarks
IGameFeatureStateChangeObserver This class is meant to be overridden in your game to handle game-specific reactions to game feature plugins being mounted or unmounted

Typedefs

Name Type Remarks Include Path
EGameFeaturePluginState GameFeaturePluginStatePrivate::EGameFeaturePluginState   GameFeatureTypes.h
FBuiltInGameFeaturePluginsLoaded FMultipleGameFeaturePluginChangeStateComplete   GameFeaturesSubsystem.h
FErrorCodeType TValueOrError< void, FString > Type used to determine if our FResult is actually an error or success (and hold the error code) GameFeaturePluginOperationResult.h
FGameFeaturePluginChangeStateComplete TBaseDelegate_OneParam< void, const UE::GameFeatures::FResult & > Notification that a game feature plugin install/register/load/unload has finished GameFeaturesSubsystem.h
FGameFeaturePluginDeactivateComplete FGameFeaturePluginChangeStateComplete   GameFeaturesSubsystem.h
FGameFeaturePluginLoadComplete FGameFeaturePluginChangeStateComplete   GameFeaturesSubsystem.h
FGameFeaturePluginReleaseComplete FGameFeaturePluginChangeStateComplete   GameFeaturesSubsystem.h
FGameFeaturePluginRequestUpdateStateMachine TBaseDelegate_NoParams< void > A request to update the state machine and process states GameFeaturesSubsystem.h
FGameFeaturePluginTerminateComplete FGameFeaturePluginChangeStateComplete   GameFeaturesSubsystem.h
FGameFeaturePluginUninstallComplete FGameFeaturePluginChangeStateComplete   GameFeaturesSubsystem.h
FGameFeaturePluginUnloadComplete FGameFeaturePluginChangeStateComplete   GameFeaturesSubsystem.h
FGameFeaturePluginUpdateProtocolComplete FGameFeaturePluginChangeStateComplete   GameFeaturesSubsystem.h
FMultipleGameFeaturePluginChangeStateComplete TDelegate< void(const TMap< FString, UE::GameFeatures::FResult > &Results)>   GameFeaturesSubsystem.h
FMultipleGameFeaturePluginsDeactivate FMultipleGameFeaturePluginChangeStateComplete   GameFeaturesSubsystem.h
FMultipleGameFeaturePluginsLoaded FMultipleGameFeaturePluginChangeStateComplete   GameFeaturesSubsystem.h
FMultipleGameFeaturePluginsReleased FMultipleGameFeaturePluginChangeStateComplete   GameFeaturesSubsystem.h
FMultipleGameFeaturePluginsTerminated FMultipleGameFeaturePluginChangeStateComplete   GameFeaturesSubsystem.h
FMultipleGameFeaturePluginsUnload FMultipleGameFeaturePluginChangeStateComplete   GameFeaturesSubsystem.h
FNotifyGameFeaturePluginRequestUpdateStateMachine TMulticastDelegate_NoParams< void >   GameFeaturesSubsystem.h
FPluginString FString Do not trigger deprecated warning for Editor builds, only for clients. GameFeaturesSubsystem.h
UGameFeatureStateHandleLoadComplete TDelegate< void(const UE::GameFeatures::FResult &)>   GameFeatureStateHandleReferenceController.h
UMultipleGameFeatureStateHandleLoadComplete TDelegate< void(const TMap< FString, UE::GameFeatures::FResult > &)> TODO these currently are no longer needed but keeping for now incase we find the return handle + refresh idea doesnt work out. GameFeatureStateHandleReferenceController.h

Enums

Public

Name Remarks
EBuiltInAutoState  
EGameFeaturePluginProtocol  
EGameFeaturesProjectPoliciesThreadSafetyVersion Specification of thread safety contract for a class derived from UGameFeaturesProjectPolicies.
EGameFeatureStateHandleOptions  
EGameFeatureTargetState  
EGameFeatureURLOptions  
EStreamingAssetInstallMode  
GameFeaturePluginStatePrivate::EGameFeaturePluginState EGameFeaturePluginState defines the list of public states for game feature plugins.
GameFeatureVersePathMapper::EBuildLookupOptions  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GameFeatureVersePathMapper::operator! ( EBuildLookupOptions E
)

   GameFeatureVersePathMapperCommandlet.h  

EBuildLookupOptions GameFeatureVersePathMapper::operator& ( EBuildLookupOptions Lhs,
EBuildLookupOptions Rhs
)

   GameFeatureVersePathMapperCommandlet.h  

EBuildLookupOptions & GameFeatureVersePathMapper::operator&= ( EBuildLookupOptions& Lhs,
EBuildLookupOptions Rhs
)

   GameFeatureVersePathMapperCommandlet.h  

EBuildLookupOptions GameFeatureVersePathMapper::operator^ ( EBuildLookupOptions Lhs,
EBuildLookupOptions Rhs
)

   GameFeatureVersePathMapperCommandlet.h  

EBuildLookupOptions & GameFeatureVersePathMapper::operator^= ( EBuildLookupOptions& Lhs,
EBuildLookupOptions Rhs
)

   GameFeatureVersePathMapperCommandlet.h  

EBuildLookupOptions GameFeatureVersePathMapper::operator| ( EBuildLookupOptions Lhs,
EBuildLookupOptions Rhs
)

   GameFeatureVersePathMapperCommandlet.h  

EBuildLookupOptions & GameFeatureVersePathMapper::operator|= ( EBuildLookupOptions& Lhs,
EBuildLookupOptions Rhs
)

   GameFeatureVersePathMapperCommandlet.h  

EBuildLookupOptions GameFeatureVersePathMapper::operator~ ( EBuildLookupOptions E
)

   GameFeatureVersePathMapperCommandlet.h  

void LexFromString ( EGameFeatureTargetState& Value,
const TCHAR* StringIn
)

   GameFeaturesSubsystem.h  

void LexFromString ( EGameFeatureURLOptions& ValueOut,
const FStringView& StringIn
)

   GameFeatureTypes.h  

const FString LexToString ( const EBuiltInAutoState BuiltInAutoState
)

   GameFeaturesSubsystem.h  

const FString LexToString ( const EGameFeatureTargetState GameFeatureTargetState
)

   GameFeaturesSubsystem.h  

const TCHAR * LexToString ( EGameFeatureURLOptions InOption
)

   GameFeatureTypes.h  
  GameFeatureStateHandle.h  
  GameFeatureTypes.h  
  GameFeatureStateHandle.h  
  GameFeatureTypes.h  
  GameFeatureStateHandle.h  
  GameFeatureTypes.h  
  GameFeatureStateHandle.h  
  GameFeatureTypes.h  
  GameFeatureStateHandle.h  
  GameFeatureTypes.h  
  GameFeatureStateHandle.h  
  GameFeatureTypes.h  
  GameFeatureStateHandle.h  
  GameFeatureTypes.h  
  GameFeatureStateHandle.h  
  GameFeatureTypes.h  

void SerializeForLog ( FCbWriter& Writer,
EGameFeaturePluginState State
)

   GameFeatureTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page