Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UEnhancedInputUserSettings

UEnhancedInputUserSettings

The Enhanced Input User Settings class is a place where you can put all of your Input Related settings that you want your user to be able to change.

API > API/Plugins > API/Plugins/EnhancedInput > API/Plugins/EnhancedInput/UserSettings

Inheritance Hierarchy

  • USaveGame
  • UEnhancedInputUserSettings

References

   
Module EnhancedInput
Header /Engine/Plugins/EnhancedInput/Source/EnhancedInput/Public/UserSettings/EnhancedInputUserSettings.h
Include #include "UserSettings/EnhancedInputUserSettings.h"

Syntax

UCLASS (Config=GameUserSettings, DisplayName="Enhanced Input User Settings",  
       Category="Enhanced Input|User Settings")  
class UEnhancedInputUserSettings : public USaveGame

Remarks

The Enhanced Input User Settings class is a place where you can put all of your Input Related settings that you want your user to be able to change. Things like their key mappings, aim sensitivity, accessibility settings, etc. This also provides a Registration point for Input Mappings Contexts (IMC) from possibly unloaded plugins (i.e. Game Feature Plugins). You can register your IMC from a Game Feature Action plugin here, and then have access to all the key mappings available. This is very useful for building settings screens because you can now access all the mappings in your game, even if the entire plugin isn't loaded yet.

The user settings are stored on each UEnhancedPlayerInput object, so each instance of the settings can represent a single User or Local Player.

To customize this for your game, you can create a subclass of it and change the "UserSettingsClass" in the Enhanced Input Project Settings.

Variables

  Type Name Description
Protected variable UProperty SaveGame FGameplayTag CurrentProfileIdentifier The current key profile that is equipped by the user.
Protected variable FTimerHandle DeferredSettingsChangedTimerHandle Used to track when a settings change callback has been deferred till the next frame.
Public variable FMappableKeyProfileChanged OnKeyProfileChanged  
Public variable FMappingContextRegisteredWithSettings OnMappingContextRegistered  
Public variable UProperty Category BlueprintAssignable Transient FEnhancedInputUserSettingsApplied OnSettingsApplied  
Public variable UProperty Category BlueprintAssignable Transient FEnhancedInputUserSettingsChanged OnSettingsChanged  
Protected variable UProperty Transient TWeakObjectPtr< ULocalPlayer > OwningLocalPlayer The owning Local Player object of these settings
Protected variable UProperty Transient TSet< TObjectPtr< const UInputMappingContext > > RegisteredMappingContexts Set of currently registered input mapping contexts that may not be currently active on the user, but you want to track for creating a menu for key mappings.
Protected variable UProperty Transient TMap< FGameplayTag, TObjectPtr< UEnhancedPlayerMappableKeyProfile > > SavedKeyProfiles All of the known Key Profiles for this user, including the currently active profile.

Functions

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category void Apply any custom input settings to your user.
Public function Virtual UFunction BlueprintCallable, Category void Asynchronously save the settings to a hardcoded save game slot.
Public function Virtual UFunction BlueprintCallable, Category, Meta UEnhancedPlayerMappableKeyProfile * Creates a new profile with this name and type.
Protected function Virtual Const FHardwareDeviceIdentifier Determines the hardware device that an action key mapping is associated with.
Public function Virtual Const const FPlayerKeyMapping *

FindCurrentMappingForSlot ( const FName MappingName,
const EPlayerMappableKeySlot InSlot
)

 Returns the current player key mapping for the given row name in the given slot
Public function Const const UInputAction *

FindInputActionForMapping ( const FName MappingName
)

 Returns the Input Action associated with the given player mapping name
Public function Virtual Const UFunction BlueprintCallable, Category const TSet< FPlayerKeyMapping > &

FindMappingsInRow ( UPARAM(Meta=(GetOptions="EnhancedInput.PlayerMappableKeySettings.GetKnownMappingNames")) const FName...
)

 Returns a set of all player key mappings for the given mapping name.
Public function Const const TMap< FGameplayTag, TObjectPtr< UEnhancedPlayerMappableKeyProfile > > & Returns all player saved key profiles
Public function Const UFunction BlueprintCallable, BlueprintPure, Category UEnhancedPlayerMappableKeyProfile * Get the current key profile that the user has set
Public function Const T * Get the current key profile that the user has set
Public function Virtual Const UFunction BlueprintCallable, BlueprintPure, Category const FGameplayTag & Gets the currently selected key profile
Public function Virtual Const UFunction BlueprintCallable, BlueprintPure, Category UEnhancedPlayerMappableKeyProfile *

GetKeyProfileWithIdentifier ( const FGameplayTag& ProfileId
)

 Returns the key profile with the given name if one exists. Null if one doesn't exist
Public function Const T *

GetKeyProfileWithIdentifierAs ( const FGameplayTag& ProfileId
)

 Returns the key profile with the given name if one exists. Null if one doesn't exist
Public function Const ULocalPlayer *  
Public function Const const TSet< TObjectPtr< const UInputMappingContext > > & Gets all the currently registered mapping contexts with the settings
Public function Virtual void

Initialize ( ULocalPlayer* LP
)

  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool Returns true if this mapping context is currently registered with the settings
Public function Static UEnhancedInputUserSettings *

LoadOrCreateSettings ( ULocalPlayer* LP
)

 Loads or creates new user settings for the owning local player of the given player input
Public function Virtual UFunction BlueprintCallable, Category, Meta void

MapPlayerKey ( const FMapPlayerKeyArgs& InArgs,
FGameplayTagContainer& FailureReason
)

 Sets the player mapped key on the current key profile.
Protected function Virtual void

OnAsyncSaveComplete ( const FString& SlotName,
const int32 UserIndex,
bool bSuccess
)

  
Protected function Virtual void

OnKeyMappingRegistered ( FPlayerKeyMapping& RegisteredMapping,
const FEnhancedActionKeyMapping& SourceMapping
)

 A virtual function that will be called whenever a player key mapping is first registered.
Protected function Virtual void

OnKeyMappingUpdated ( FPlayerKeyMapping* ChangedMapping,
const FMapPlayerKeyArgs& InArgs,
const bool bIsBeingUnmapped
)

 A virtual function that will be called whenever a player key mapping has been updated, before OnSettingsChanged is called.
Public function Virtual UFunction BlueprintCallable, Category bool Registers this mapping context with the user settings.
Public function UFunction BlueprintCallable, Category bool

RegisterInputMappingContexts ( const TSet< UInputMappingContext* >& MappingContexts
)

 Registers multiple mapping contexts with the settings
Protected function Virtual bool This will register individual key mappings from the given Input Mapping context on the profile id.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

ResetAllPlayerKeysInRow ( const FMapPlayerKeyArgs& InArgs,
FGameplayTagContainer& FailureReason
)

 Resets each player mapped key to it's default value from the Input Mapping Context that it was registered from.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

ResetKeyProfileToDefault ( const FGameplayTag& ProfileId,
FGameplayTagContainer& FailureReason
)

 Resets the given key profile to default key mappings
Public function Virtual UFunction BlueprintCallable, Category void Synchronously save the settings to a hardcoded save game slot.
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function Virtual UFunction BlueprintCallable, Category, Meta bool

SetKeyProfile ( const FGameplayTag& InProfileId
)

 Changes the currently active key profile to the one with the given name.
Public function Const void

ShowDebugInfo ( UCanvas* Canvas
)

 Draw debug information on the screen for these user settings.
Protected function Virtual Const void

ShowDebugInfoInternal ( UCanvas* Canvas
)

 Provides a space for subclasses to add additional debug info if desired.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

UnMapPlayerKey ( const FMapPlayerKeyArgs& InArgs,
FGameplayTagContainer& FailureReason
)

 Unmaps a single player mapping that matches the given Mapping name, slot, and hardware device.
Public function Virtual UFunction BlueprintCallable, Category bool Removes this mapping context from the registered mapping contexts
Public function UFunction BlueprintCallable, Category bool

UnregisterInputMappingContexts ( const TSet< UInputMappingContext* >& MappingContexts
)

 Removes multiple mapping contexts from the registered mapping contexts

Classes

  Type Name Description
Public class FEnhancedInputUserSettingsApplied Called after the settings have been applied from the ApplySettings call.  
Public class FEnhancedInputUserSettingsChanged Fired when the user settings have changed, such as their key mappings.  
Public class FMappableKeyProfileChanged Fired when you equip a different key profile  
Public class FMappingContextRegisteredWithSettings Registering input mapping contexts for access to them from your UI, even if they are from a plugin Fired when a new input mapping context is registered.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page