1. Epic GamesDeveloper
  3. UCommonInputSettings

UCommonInputSettings

API > API/Plugins > API/Plugins/CommonInput

   
Name UCommonInputSettings
Type class
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonInput/Public/CommonInputSettings.h
Include Path #include "CommonInputSettings.h"

Syntax

UCLASS (MinimalAPI, Config=Game, defaultconfig)  
class UCommonInputSettings : public UDeveloperSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCommonInputSettings ( const FObjectInitializer& Initializer
)

   CommonInputSettings.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActionDomainTable TSoftObjectPtr< UCommonInputActionDomainTable > Create a derived asset from UCommonInputActionDomainTable to store ordered ActionDomain data for your game CommonInputSettings.h
  • Config
  • EditAnywhere
  • Category="Action Domain"
ActionDomainTablePtr TObjectPtr< UCommonInputActionDomainTable >   CommonInputSettings.h
  • Transient
bActionDomainTableLoaded bool   CommonInputSettings.h  
bAllowOutOfFocusDeviceInput bool   CommonInputSettings.h
  • Config
  • EditAnywhere
  • Category="Input"
bEnableAutomaticGamepadTypeDetection bool Controls automatic detection of the gamepad type. CommonInputSettings.h
  • Config
  • EditAnywhere
  • Category="Input"
bEnableDefaultInputConfig bool Controls whether a default Input Config will be set when the active CommonActivatableWidgets do not specify a desired one. CommonInputSettings.h
  • Config
  • EditAnywhere
  • Category="Input"
bEnableEnhancedInputSupport bool Controls if Enhanced Input Support plugin-wide. Requires restart due to caching. CommonInputSettings.h
  • Config
  • EditAnywhere
  • Category="Input"
  • Meta=(ConfigRestartRequired=true)
bEnableInputMethodThrashingProtection bool   CommonInputSettings.h
  • Config
  • EditAnywhere
  • Category="Thrashing Settings"
bInputDataLoaded bool   CommonInputSettings.h  
InputData TSoftClassPtr< UCommonUIInputData > Create a derived asset from UCommonUIInputData to store Input data for your game. CommonInputSettings.h
  • Config
  • EditAnywhere
  • Category="Input"
  • Meta=(AllowAbstract=false)
InputDataClass TSubclassOf< UCommonUIInputData >   CommonInputSettings.h
  • Transient
InputMethodThrashingCooldownInSeconds double   CommonInputSettings.h
  • Config
  • EditAnywhere
  • Category="Thrashing Settings"
InputMethodThrashingLimit int32   CommonInputSettings.h
  • Config
  • EditAnywhere
  • Category="Thrashing Settings"
InputMethodThrashingWindowInSeconds double   CommonInputSettings.h
  • Config
  • EditAnywhere
  • Category="Thrashing Settings"
PlatformInput FPerPlatformSettings   CommonInputSettings.h
  • EditAnywhere
  • Category="Input"
PlatformNameUpgrades TMap< FName, FName > A map of Common Input platform names to a new one, which you can use to upgrade your Input Action data tables if you add a new platform to your project and wish to copy from some existing data CommonInputSettings.h
  • Config
  • EditAnywhere
  • Category="Input"
  • Meta=(ConfigRestartRequired=true)

Functions

Public

Name Remarks Include Path Unreal Specifiers

TObjectPtr< UCommonInputActionDomainTable > GetActionDomainTable()

   CommonInputSettings.h  

bool GetAllowOutOfFocusDeviceInput()

   CommonInputSettings.h  

FDataTableRowHandle GetDefaultBackAction()

   CommonInputSettings.h  

FDataTableRowHandle GetDefaultClickAction()

   CommonInputSettings.h  

TSubclassOf< UCommonUIHoldData > GetDefaultHoldData()

 Default Hold Data CommonInputSettings.h  

bool GetEnableAutomaticGamepadTypeDetection()

   CommonInputSettings.h  

bool GetEnableDefaultInputConfig()

   CommonInputSettings.h  

bool GetEnableEnhancedInputSupport()

   CommonInputSettings.h  

bool GetEnableInputMethodThrashingProtection()

   CommonInputSettings.h  

UInputAction * GetEnhancedInputBackAction()

   CommonInputSettings.h  

UInputAction * GetEnhancedInputClickAction()

   CommonInputSettings.h  

double GetInputMethodThrashingCooldownInSeconds()

   CommonInputSettings.h  

int32 GetInputMethodThrashingLimit()

   CommonInputSettings.h  

double GetInputMethodThrashingWindowInSeconds()

   CommonInputSettings.h  

const TMap< FName, FName > & GetPlatformNameUpgradeMap()

   CommonInputSettings.h  

void LoadData()

 Called to load CommonUISetting data, if bAutoLoadData if set to false then game code must call LoadData(). CommonInputSettings.h  

void ValidateData()

 Called to check that the data we have previously attempted to load is actually loaded and will attempt to load if it is not. CommonInputSettings.h  

Overridden from UDeveloperSettings

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   CommonInputSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool IsEnhancedInputSupportEnabled()

 Static version of enhanced input support check, exists to hide based on edit condition CommonInputSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page