Navigation
API > API/Plugins > API/Plugins/CommonUI
Project-wide input settings for UI input actions
| Name | UCommonUIInputSettings |
| Type | class |
| Header File | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/Input/CommonUIInputSettings.h |
| Include Path | #include "Input/CommonUIInputSettings.h" |
Syntax
UCLASS (Config=Input, defaultconfig, MinimalAPI)
class UCommonUIInputSettings : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCommonUIInputSettings
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActionOverrides | TArray< FUIInputAction > | Config-only set of input action overrides - if an entry for a given action is both here and in the InputActions array, this entry wins completely. | Input/CommonUIInputSettings.h |
|
| AnalogCursorSettings | FCommonAnalogCursorSettings | Input/CommonUIInputSettings.h |
|
|
| bLinkCursorToGamepadFocus | bool | True to have the mouse pointer automatically moved to the center of whatever widget is currently focused while using a gamepad. | Input/CommonUIInputSettings.h |
|
| InputActions | TArray< FUIInputAction > | All UI input action mappings for the project | Input/CommonUIInputSettings.h |
|
| UIActionProcessingPriority | int32 | The input priority of the input components that process UI input actions. | Input/CommonUIInputSettings.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FUIInputAction * FindAction
(
FUIActionTag ActionTag |
Input/CommonUIInputSettings.h | ||
const FCommonAnalogCursorSettings & GetAnalogCursorSettings() |
Input/CommonUIInputSettings.h | ||
int32 GetUIActionProcessingPriority() |
Input/CommonUIInputSettings.h | ||
const TArray< FUIInputAction > & GetUIInputActions() |
Input/CommonUIInputSettings.h | ||
bool ShouldLinkCursorToGamepadFocus() |
Input/CommonUIInputSettings.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostInitProperties() |
Input/CommonUIInputSettings.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const UCommonUIInputSettings & Get() |
Input/CommonUIInputSettings.h |