Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Current state of physical input devices at a point in time. Assumption is that the state refers to a single physical input device, ie InputDevice field is a single value of EInputDevices and not a combination.
| Name | FInputDeviceState |
| Type | struct |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/InputState.h |
| Include Path | #include "InputState.h" |
Syntax
USTRUCT (BlueprintType )
struct FInputDeviceState
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FInputDeviceState() |
InputState.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAltKeyDown | bool | Is they keyboard ALT modifier key currently pressed down | InputState.h |
|
| bCmdKeyDown | bool | Is they keyboard CMD modifier key currently pressed down (only on Apple devices) | InputState.h |
|
| bCtrlKeyDown | bool | Is they keyboard CTRL modifier key currently pressed down | InputState.h |
|
| bShiftKeyDown | bool | Keyboard modifiers Is they keyboard SHIFT modifier key currently pressed down | InputState.h |
|
| InputDevice | EInputDevices | Which InputDevice member is valid in this state | InputState.h |
|
| Keyboard | FKeyboardInputDeviceState | Current state of Keyboard device, if InputDevice == EInputDevices::Keyboard | InputState.h |
|
| Mouse | FMouseInputDeviceState | Current state of Mouse device, if InputDevice == EInputDevices::Mouse | InputState.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsFromDevice
(
EInputDevices DeviceType |
InputState.h | ||
void SetModifierKeyStates
(
bool bShiftDown, |
Update keyboard modifier key states | InputState.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool IsAltKeyDown
(
const FInputDeviceState& InputState |
InputState.h | ||
static bool IsCmdKeyDown
(
const FInputDeviceState& InputState |
InputState.h | ||
static bool IsCtrlKeyDown
(
const FInputDeviceState& InputState |
InputState.h | ||
static bool IsShiftKeyDown
(
const FInputDeviceState& InputState |
Utility functions to pass as lambdas | InputState.h |