Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > GameFramework > UInputSettings

Light Theme

Dark Theme

UInputSettings

Project wide settings for input handling

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInputSettings

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/GameFramework/InputSettings.h
Include	#include "GameFramework/InputSettings.h"

Syntax

class UInputSettings : public UObject

Remarks

Project wide settings for input handling

Variables

	Name	Description
TArray< struct ...	AxisConfig	Properties of Axis controls
uint8: 1	bAltEnterTogglesFullscreen
uint8: 1	bAlwaysShowTouchInterface	Should the touch input interface be shown always, or only when the platform has a touch screen?
uint8: 1	bCaptureMouseOnLaunch	Controls if the viewport will capture the mouse on Launch of the application
uint8: 1	bEnableFOVScaling	Scale the mouse based on the player camera manager's field of view.
uint8: 1	bEnableGestureRecognizer	Whether or not to use the gesture recognition system to convert touches in to gestures that can be bound and queried
uint8: 1	bEnableMouseSmoothing	Mouse smoothing control.
uint8: 1	bF11TogglesFullscreen
uint8: 1	bShowConsoleOnFourFingerTap	Whether or not to show the console on 4 finger tap, on mobile platforms
bool	bUseAutocorrect	If enabled, virtual keyboards will have autocorrect enabled.
uint8: 1	bUseMouseForTouch	Allow mouse to be used for touch.
TArray< FKey >	ConsoleKeys	The keys which open the console.
FSoftObjectPath	DefaultTouchInterface	The default on-screen touch input interface for the game (can be null to disable the onscreen interface)
EMouseCaptureMo...	DefaultViewportMouseCaptureMode	The default mouse capture mode for the game viewport
EMouseLockMode	DefaultViewportMouseLockMode	The default mouse lock state behavior when the viewport acquires capture
float	DoubleClickTime	If a key is pressed twice in this amount of time it is considered a "double click"
TArray< FString...	ExcludedAutocorrectCultures	Disables autocorrect for these cultures, even if autocorrect is turned on.
TArray< FString...	ExcludedAutocorrectDeviceModels	Disables autocorrect for these device models, even if autocorrect is turned in.
TArray< FString...	ExcludedAutocorrectOS	Disables autocorrect for these operating systems, even if autocorrect is enabled.
float	FOVScale	The scaling value to multiply the field of view by.

Constructors

	Name	Description
	UInputSettings ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddActionMapping ( const FInputActionKeyMapping& KeyM..., bool bForceRebuildKeymaps )	Programmatically add an action mapping to the project defaults
void	AddActionMapping ( FInputActionKeyMapping& NewMapping )	Append new mapping to existing list
void	AddAxisMapping ( const FInputAxisKeyMapping& KeyMap..., bool bForceRebuildKeymaps )	Programmatically add an axis mapping to the project defaults
void	AddAxisMapping ( FInputAxisKeyMapping& NewMapping )	Append new mapping to existing list
bool	DoesActionExist ( const FName InActionName )	Finds unique action name based on existing action names
bool	DoesAxisExist ( const FName InAxisName )	Finds unique axis name based on existing action names
bool	DoesSpeechExist ( const FName InSpeechName )	Finds unique speech name based on existing speech names
void	ForceRebuildKeymaps()	When changes are made to the default mappings, push those changes out to PlayerInput key maps
void	GetActionMappingByName ( const FName InActionName, TArray< FInputActionKeyMapping >& ... )
const TArray...	GetActionMappings()	Ask for all the action mappings
const FName	GetActionMappingsPropertyName()	Get the member name for the details panel
void	GetActionNames ( TArray< FName >& ActionNames )	Populate a list of all defined action names
void	GetAxisMappingByName ( const FName InAxisName, TArray< FInputAxisKeyMapping >& Ou... )	Retrieve all axis mappings by a certain name.
const TArray...	GetAxisMappings()	Ask for all the axis mappings
const FName	GetAxisMappingsPropertyName()	Get the member name for the details panel
void	GetAxisNames ( TArray< FName >& AxisNames )	Populate a list of all defined axis names
UClass *	GetDefaultInputComponentClass()
UClass *	GetDefaultPlayerInputClass()	Class accessors.
UInputSettin...	GetInputSettings()	Returns the game local input settings (action mappings, axis mappings, etc...)
const TArray...	GetSpeechMappings()	Ask for all the speech mappings
FName	GetUniqueActionName ( const FName BaseActionMappingName )	Finds unique action name based on existing action names
FName	GetUniqueAxisName ( const FName BaseAxisMappingName )	Finds unique axis name based on existing action names
void	RemoveActionMapping ( const FInputActionKeyMapping& KeyM..., bool bForceRebuildKeymaps )	Programmatically remove an action mapping to the project defaults
void	RemoveAxisMapping ( const FInputAxisKeyMapping& KeyMap..., bool bForceRebuildKeymaps )	Programmatically remove an axis mapping to the project defaults
void	RemoveInvalidKeys()
void	SaveKeyMappings()	Flush the current mapping values to the config file

Overridden from UObject

	Name	Description
void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostReloadConfig ( FProperty* PropertyThatWasLoad... )	Called from ReloadConfig after the object has reloaded its configuration data.

Deprecated Variables

		Name	Description
	uint8: 1	bDefaultViewportMouseLock_DEPRECATED	The default mouse lock state when the viewport acquires capture
	FKey	ConsoleKey_DEPRECATED	The key which opens the console.