1. Epic GamesDeveloper
  3. UInputSettings

UInputSettings

Project wide settings for input handling

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/GameFramework

Inheritance Hierarchy

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

  Type Name Description
Public variable TArray< struct FInputAxisConfigEntry > AxisConfig Properties of Axis controls
Public variable uint8: 1 bAltEnterTogglesFullscreen  
Public variable uint8: 1 bAlwaysShowTouchInterface Should the touch input interface be shown always, or only when the platform has a touch screen?
Public variable uint8: 1 bCaptureMouseOnLaunch Controls if the viewport will capture the mouse on Launch of the application
Public variable uint8: 1 bEnableDynamicComponentInputBinding Should components that are dynamically added via the 'AddComponent' function at runtime have input delegates bound to them?
Public variable uint8: 1 bEnableFOVScaling Scale the mouse based on the player camera manager's field of view.
Public variable uint8: 1 bEnableGestureRecognizer Whether or not to use the gesture recognition system to convert touches in to gestures that can be bound and queried
Public variable uint8: 1 bEnableInputDeviceSubsystem If true, then the input device subsystem will be allowed to Initalize when the engine boots.
Public variable uint8: 1 bEnableLegacyInputScales Enable the use of legacy input scales on the player controller (InputYawScale, InputPitchScale, and InputRollScale)
Public variable uint8: 1 bEnableMotionControls If set to false, then the player controller's InputMotion function will never be called.
Public variable uint8: 1 bEnableMouseSmoothing Mouse smoothing control.
Public variable uint8: 1 bF11TogglesFullscreen  
Public variable uint8: 1 bFilterInputByPlatformUser 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.
Public variable uint8: 1 bShouldFlushPressedKeysOnViewportFocusLost 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.
Public variable uint8: 1 bShowConsoleOnFourFingerTap Whether or not to show the console on 4 finger tap, on mobile platforms
Public variable uint8: 1 bUseAutocorrect If enabled, virtual keyboards will have autocorrect enabled.
Public variable uint8: 1 bUseMouseForTouch Allow mouse to be used for touch.
Public variable TArray< FKey > ConsoleKeys The keys which open the console.
Public variable FSoftObjectPath DefaultTouchInterface The default on-screen touch input interface for the game (can be null to disable the onscreen interface)
Public variable EMouseCaptureMode DefaultViewportMouseCaptureMode The default mouse capture mode for the game viewport
Public variable EMouseLockMode DefaultViewportMouseLockMode The default mouse lock state behavior when the viewport acquires capture
Public variable float DoubleClickTime If a key is pressed twice in this amount of time it is considered a "double click"
Public variable TArray< FString > ExcludedAutocorrectCultures Disables autocorrect for these cultures, even if autocorrect is turned on.
Public variable TArray< FString > ExcludedAutocorrectDeviceModels Disables autocorrect for these device models, even if autocorrect is turned in.
Public variable TArray< FString > ExcludedAutocorrectOS Disables autocorrect for these operating systems, even if autocorrect is enabled.
Public variable float FOVScale The scaling value to multiply the field of view by.
Public variable FPerPlatformSettings PlatformSettings Platform specific settings for Input.

Constructors

  Type Name Description
Public function  

UInputSettings ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddActionMapping ( const FInputActionKeyMapping& KeyMapping,
bool bForceRebuildKeymaps
)

 Programmatically add an action mapping to the project defaults
Public function void Append new mapping to existing list
Public function void

AddAxisMapping ( const FInputAxisKeyMapping& KeyMapping,
bool bForceRebuildKeymaps
)

 Programmatically add an axis mapping to the project defaults
Public function void Append new mapping to existing list
Public function bool

DoesActionExist ( const FName InActionName
)

 Finds unique action name based on existing action names
Public function bool

DoesAxisExist ( const FName InAxisName
)

 Finds unique axis name based on existing action names
Public function bool

DoesSpeechExist ( const FName InSpeechName
)

 Finds unique speech name based on existing speech names
Public function void When changes are made to the default mappings, push those changes out to PlayerInput key maps
Public function Const void

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

  
Public function Const const TArray< FInputActionKeyMapping > & Ask for all the action mappings
Public function Static const FName Get the member name for the details panel
Public function Const void

GetActionNames ( TArray< FName >& ActionNames
)

 Populate a list of all defined action names
Public function Static const TArray< FName > & 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.
Public function Const void

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

 Retrieve all axis mappings by a certain name.
Public function Const const TArray< FInputAxisKeyMapping > & Ask for all the axis mappings
Public function Static const FName Get the member name for the details panel
Public function Const void

GetAxisNames ( TArray< FName >& AxisNames
)

 Populate a list of all defined axis names
Public function Static UClass *  
Public function Static UClass * Class accessors.
Public function Static UInputSettings * Returns the game local input settings (action mappings, axis mappings, etc...)
Public function Const const TArray< FInputActionSpeechMapping > & Ask for all the speech mappings
Public function FName

GetUniqueActionName ( const FName BaseActionMappingName
)

 Finds unique action name based on existing action names
Public function FName

GetUniqueAxisName ( const FName BaseAxisMappingName
)

 Finds unique axis name based on existing action names
Public function void

RemoveActionMapping ( const FInputActionKeyMapping& KeyMapping,
bool bForceRebuildKeymaps
)

 Programmatically remove an action mapping to the project defaults
Public function void

RemoveAxisMapping ( const FInputAxisKeyMapping& KeyMapping,
bool bForceRebuildKeymaps
)

 Programmatically remove an axis mapping to the project defaults
Public function void  
Public function void Flush the current mapping values to the config file
Public function Static void

SetDefaultInputComponentClass ( TSubclassOf< UInputComponent > NewDefaultInputComponentClass
)

 Set the default input component class.
Public function Static void

SetDefaultPlayerInputClass ( TSubclassOf< UPlayerInput > NewDefaultPlayerInputClass
)

 Set the default player input class.

Overridden from UObject

  Type Name Description
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void

PostReloadConfig ( FProperty* PropertyThatWasLoaded
)

 Called from ReloadConfig after the object has reloaded its configuration data.

See Also

https://docs.unrealengine.com/latest/INT/Gameplay/Input/index.html

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page