Navigation
API > API/Plugins > API/Plugins/CommonUI
Input Config that can be applied on widget activation. Allows for input setup (Mouse capture, UI-only input, move / look ignore, etc), to be controlled by widget activation.
| Name | FUIInputConfig |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/Input/UIActionBindingHandle.h |
| Include Path | #include "Input/UIActionBindingHandle.h" |
Syntax
USTRUCT (BlueprintType )
struct FUIInputConfig
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Input/UIActionBindingHandle.h | |||
FUIInputConfig
(
ECommonInputMode InInputMode, |
Input/UIActionBindingHandle.h | ||
FUIInputConfig
(
ECommonInputMode InInputMode, |
Input/UIActionBindingHandle.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIgnoreLookInput | bool | Input/UIActionBindingHandle.h |
|
|
| bIgnoreMoveInput | bool | Input/UIActionBindingHandle.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ECommonInputMode GetInputMode() |
Input/UIActionBindingHandle.h | ||
EMouseCaptureMode GetMouseCaptureMode() |
Input/UIActionBindingHandle.h | ||
EMouseLockMode GetMouseLockMode() |
Input/UIActionBindingHandle.h | ||
bool HideCursorDuringViewportCapture() |
Input/UIActionBindingHandle.h | ||
FString ToString() |
Simplification of config as string | Input/UIActionBindingHandle.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FUIInputConfig& Other |
Input/UIActionBindingHandle.h | ||
bool operator==
(
const FUIInputConfig& Other |
Input/UIActionBindingHandle.h |