1. Epic GamesDeveloper
  3. UInputSettings

UInputSettings

Project wide settings for input handling

API > API/Runtime > API/Runtime/Engine

Project wide settings for input handling

   
Name UInputSettings
Type class
Header File /Engine/Source/Runtime/Engine/Classes/GameFramework/InputSettings.h
Include Path #include "GameFramework/InputSettings.h"

Syntax

UCLASS (Config=Input, defaultconfig, MinimalAPI)  
class UInputSettings : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UInputSettings ( const FObjectInitializer& ObjectInitializer
)

   GameFramework/InputSettings.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AxisConfig TArray< struct FInputAxisConfigEntry > Properties of Axis controls GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • EditFixedSize
  • Category="Bindings"
  • Meta=(ToolTip="List of Axis Properties")
  • AdvancedDisplay
bAltEnterTogglesFullscreen uint8   GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Bindings"
  • AdvancedDisplay
bAlwaysShowTouchInterface uint8 Should the touch input interface be shown always, or only when the platform has a touch screen? GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Mobile"
bCaptureMouseOnLaunch uint8 Controls if the viewport will capture the mouse on Launch of the application GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="ViewportProperties"
bEnabledLegacyMappingDeprecationWarnings uint8 If true, then any input action or axis mappings which are marked as deprecated will throw a warning. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Bindings"
bEnableDynamicComponentInputBinding uint8 Should components that are dynamically added via the 'AddComponent' function at runtime have input delegates bound to them? GameFramework/InputSettings.h
  • Config
  • Meta=(DeprecatedProperty, DeprecationMessage="bEnableDynamicComponentInputBinding is deprecated, it will be treated as always being true.")
bEnableFOVScaling uint8 Scale the mouse based on the player camera manager's field of view. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="MouseProperties"
  • AdvancedDisplay
bEnableGestureRecognizer uint8 Whether or not to use the gesture recognition system to convert touches in to gestures that can be bound and queried GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Mobile"
bEnableLegacyInputScales uint8 Enable the use of legacy input scales on the player controller (InputYawScale, InputPitchScale, and InputRollScale) GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Input"
bEnableMotionControls uint8 If set to false, then the player controller's InputMotion function will never be called. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Input"
bEnableMouseSmoothing uint8 Mouse smoothing control. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="MouseProperties"
  • AdvancedDisplay
bF11TogglesFullscreen uint8   GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Bindings"
  • AdvancedDisplay
bFilterInputByPlatformUser uint8 If true, then the PlayerController::InputKey function will only process an input event if it came from an input device that is owned by the PlayerController's Platform User. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Input"
bShouldFlushPressedKeysOnViewportFocusLost uint8 If true, then the Player Controller will have it's Pressed Keys flushed when the input mode is changed to Game and UI mode or the game viewport loses focus. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Input"
bShowConsoleOnFourFingerTap uint8 Whether or not to show the console on 4 finger tap, on mobile platforms GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Mobile"
bUseAutocorrect uint8 If enabled, virtual keyboards will have autocorrect enabled. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Virtual Keyboard (Mobile)"
bUseMouseForTouch uint8 Allow mouse to be used for touch. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="MouseProperties"
  • AdvancedDisplay
ConsoleKeys TArray< FKey > The keys which open the console. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Console"
DefaultTouchInterface FSoftObjectPath The default on-screen touch input interface for the game (can be null to disable the onscreen interface) GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Mobile"
  • Meta=(AllowedClasses="/Script/Engine.TouchInterface")
DefaultViewportMouseCaptureMode EMouseCaptureMode The default mouse capture mode for the game viewport GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="ViewportProperties"
DefaultViewportMouseLockMode EMouseLockMode The default mouse lock state behavior when the viewport acquires capture GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="ViewportProperties"
DoubleClickTime float If a key is pressed twice in this amount of time it is considered a "double click" GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="MouseProperties"
  • AdvancedDisplay
ExcludedAutocorrectCultures TArray< FString > Disables autocorrect for these cultures, even if autocorrect is turned on. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • AdvancedDisplay
  • Category="Virtual Keyboard (Mobile)"
ExcludedAutocorrectDeviceModels TArray< FString > Disables autocorrect for these device models, even if autocorrect is turned in. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • AdvancedDisplay
  • Category="Virtual Keyboard (Mobile)"
ExcludedAutocorrectOS TArray< FString > Disables autocorrect for these operating systems, even if autocorrect is enabled. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • AdvancedDisplay
  • Category="Virtual Keyboard (Mobile)"
FOVScale float The scaling value to multiply the field of view by. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="MouseProperties"
  • AdvancedDisplay
  • Meta=(editcondition="bEnableFOVScaling")
PlatformSettings FPerPlatformSettings Platform specific settings for Input. GameFramework/InputSettings.h
  • EditAnywhere
  • Category="Platforms"

Protected

Name Type Remarks Include Path Unreal Specifiers
ActionMappings TArray< struct FInputActionKeyMapping > List of Action Mappings GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Bindings"
AxisMappings TArray< struct FInputAxisKeyMapping > List of Axis Mappings GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Bindings"
DefaultInputComponentClass TSoftClassPtr< UInputComponent > Default class type for pawn input components. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • NoClear
  • Category=DefaultClasses
DefaultPlayerInputClass TSoftClassPtr< UPlayerInput > Default class type for player input object. May be overridden by player controller. GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • NoClear
  • Category=DefaultClasses
DeprecatedActionAndAxisNames TSet< FName > List of FNames, where each name is either an Action or Axis mapping, which are marked as deprecated. GameFramework/InputSettings.h
  • Config
  • VisibleAnywhere
  • Category="Bindings"
SpeechMappings PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< struct FInputActionSpeechMapping > List of Speech Mappings GameFramework/InputSettings.h
  • Config
  • EditAnywhere
  • Category="Bindings"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddActionMapping ( const FInputActionKeyMapping& KeyMapping,
bool bForceRebuildKeymaps
)

 Programmatically add an action mapping to the project defaults GameFramework/InputSettings.h
  • BlueprintCallable
  • Category=Settings
Append new mapping to existing list GameFramework/InputSettings.h  

void AddAxisMapping ( const FInputAxisKeyMapping& KeyMapping,
bool bForceRebuildKeymaps
)

 Programmatically add an axis mapping to the project defaults GameFramework/InputSettings.h
  • BlueprintCallable
  • Category=Settings

void AddAxisMapping ( FInputAxisKeyMapping& NewMapping
)

 Append new mapping to existing list GameFramework/InputSettings.h  

bool DoesActionExist ( const FName InActionName
)

 Finds unique action name based on existing action names GameFramework/InputSettings.h  

bool DoesAxisExist ( const FName InAxisName
)

 Finds unique axis name based on existing action names GameFramework/InputSettings.h  

bool DoesSpeechExist ( const FName InSpeechName
)

 Finds unique speech name based on existing speech names GameFramework/InputSettings.h  

void ForceRebuildKeymaps()

 When changes are made to the default mappings, push those changes out to PlayerInput key maps GameFramework/InputSettings.h
  • BlueprintCallable
  • Category=Settings

void GetActionMappingByName ( const FName InActionName,
TArray< FInputActionKeyMapping >& OutMappings
) const

   GameFramework/InputSettings.h
  • BlueprintPure
  • Category=Settings

const TArray< FInputActionKeyMapping > & GetActionMappings()

 Ask for all the action mappings GameFramework/InputSettings.h  

void GetActionNames ( TArray< FName >& ActionNames
) const

 Populate a list of all defined action names GameFramework/InputSettings.h
  • BlueprintCallable
  • Category=Settings

void GetAxisMappingByName ( const FName InAxisName,
TArray< FInputAxisKeyMapping >& OutMappings
) const

 Retrieve all axis mappings by a certain name. GameFramework/InputSettings.h
  • BlueprintPure
  • Category=Settings

const TArray< FInputAxisKeyMapping > & GetAxisMappings()

 Ask for all the axis mappings GameFramework/InputSettings.h  

void GetAxisNames ( TArray< FName >& AxisNames
) const

 Populate a list of all defined axis names GameFramework/InputSettings.h
  • BlueprintCallable
  • Category=Settings

PRAGMA_DISABLE_DEPRECATION_WARNINGS const TArray< FInputActionSpeechMapping > & GetSpeechMappings()

 Ask for all the speech mappings GameFramework/InputSettings.h  

FName GetUniqueActionName ( const FName BaseActionMappingName
)

 Finds unique action name based on existing action names GameFramework/InputSettings.h  

FName GetUniqueAxisName ( const FName BaseAxisMappingName
)

 Finds unique axis name based on existing action names GameFramework/InputSettings.h  

bool IsActionMappingDeprecated ( const FName ActionName
) const

   GameFramework/InputSettings.h  

void RemoveActionMapping ( const FInputActionKeyMapping& KeyMapping,
bool bForceRebuildKeymaps
)

 Programmatically remove an action mapping to the project defaults GameFramework/InputSettings.h
  • BlueprintCallable
  • Category=Settings

void RemoveAxisMapping ( const FInputAxisKeyMapping& KeyMapping,
bool bForceRebuildKeymaps
)

 Programmatically remove an axis mapping to the project defaults GameFramework/InputSettings.h
  • BlueprintCallable
  • Category=Settings

void RemoveInvalidKeys()

   GameFramework/InputSettings.h  

void SaveKeyMappings()

 Flush the current mapping values to the config file GameFramework/InputSettings.h
  • BlueprintCallable
  • Category=Settings

void SetActionMappingDeprecated ( const FName ActionName,
const bool bIsDeprecated
)

   GameFramework/InputSettings.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   GameFramework/InputSettings.h  

virtual void PostInitProperties()

   GameFramework/InputSettings.h  

virtual void PostReloadConfig ( FProperty* PropertyThatWasLoaded
)

   GameFramework/InputSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FName GetActionMappingsPropertyName()

 Get the member name for the details panel GameFramework/InputSettings.h  

static const TArray< FName > & GetAllActionAndAxisNames ()

 Returns all known legacy action and axis names that is useful for properties that you want a drop down selection of the available names on a UPROPERTY i.e. GameFramework/InputSettings.h  

static const FName GetAxisMappingsPropertyName()

 Get the member name for the details panel GameFramework/InputSettings.h  

static UClass * GetDefaultInputComponentClass()

   GameFramework/InputSettings.h  

static UClass * GetDefaultPlayerInputClass()

 Class accessors. GameFramework/InputSettings.h  

static UInputSettings * GetInputSettings()

 Returns the game local input settings (action mappings, axis mappings, etc...) GameFramework/InputSettings.h
  • BlueprintPure
  • Category=Settings

static void SetDefaultInputComponentClass ( TSubclassOf< UInputComponent > NewDefaultInputComponentClass
)

 Set the default input component class. GameFramework/InputSettings.h  

static void SetDefaultPlayerInputClass ( TSubclassOf< UPlayerInput > NewDefaultPlayerInputClass
)

 Set the default player input class. GameFramework/InputSettings.h  

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page