Input Namespace Reference

Functions
Input|AnalogEvent
EUINavigation	Key_GetNavigationDirectionFromAnalog (FAnalogInputEvent InAnalogEvent)
	Returns the navigation action corresponding to this key, or Invalid if not found.
Input|InputEvent
bool	InputEvent_IsCommandDown (FInputEvent Input)
	Returns true if either command key was down when this event occurred.
bool	InputEvent_IsControlDown (FInputEvent Input)
	Returns true if either control key was down when this event occurred.
float32	GetAnalogValue (FAnalogInputEvent Input)
bool	InputEvent_IsLeftAltDown (FInputEvent Input)
	Returns true if left alt key was down when this event occurred.
bool	InputEvent_IsShiftDown (FInputEvent Input)
	Returns true if either shift key was down when this event occurred.
bool	InputEvent_IsRightShiftDown (FInputEvent Input)
	Returns true if right shift key was down when this event occurred.
bool	InputEvent_IsLeftCommandDown (FInputEvent Input)
	Returns true if left command key was down when this event occurred.
bool	InputEvent_IsAltDown (FInputEvent Input)
	Returns true if either alt key was down when this event occurred.
bool	InputEvent_IsRightControlDown (FInputEvent Input)
	Returns true if left control key was down when this event occurred.
bool	InputEvent_IsRightAltDown (FInputEvent Input)
	Returns true if right alt key was down when this event occurred.
bool	InputEvent_IsRepeat (FInputEvent Input)
	Returns whether or not this character is an auto-repeated keystroke.
bool	InputEvent_IsLeftControlDown (FInputEvent Input)
	Returns true if left control key was down when this event occurred.
bool	InputEvent_IsLeftShiftDown (FInputEvent Input)
	Returns true if left shift key was down when this event occurred.
bool	InputEvent_IsRightCommandDown (FInputEvent Input)
	Returns true if right command key was down when this event occurred.
Input|Key
FText	InputChord_GetDisplayName (FInputChord Key)
bool	EqualEqual_InputChordInputChord (FInputChord A, FInputChord B)
	Test if the input chords are equal (A == B).
bool	EqualEqual_KeyKey (FKey A, FKey B)
	Test if the input key are equal (A == B).
bool	Key_IsAxis1D (FKey Key)
	Returns true if the key is a 1D (float) axis.
bool	Key_IsValid (FKey Key)
	Returns true if this is a valid key.
bool	Key_IsVectorAxis (FKey Key)
	Returns true if the key is a vector axis Note: Deprecated. Use Is Axis 2D/3D instead.
FText	Key_GetDisplayName (FKey Key, bool bLongDisplayName=true)
	Returns the display name of the key.
EUINavigationAction	Key_GetNavigationAction (FKey InKey)
bool	Key_IsAxis3D (FKey Key)
	Returns true if the key is a 3D (vector) axis.
bool	Key_IsButtonAxis (FKey Key)
	Returns true if the key is a 1D axis emulating a digital button press.
bool	Key_IsKeyboardKey (FKey Key)
	Returns true if the key is a keyboard button.
bool	Key_IsModifierKey (FKey Key)
	Returns true if the key is a modifier key: Ctrl, Command, Alt, Shift.
bool	Key_IsAxis2D (FKey Key)
	Returns true if the key is a 2D (vector) axis.
bool	Key_IsAnalog (FKey Key)
	Returns true if the key is an analog axis.
bool	Key_IsMouseButton (FKey Key)
	Returns true if the key is a mouse button.
bool	Key_IsDigital (FKey Key)
	Returns true if the key is a digital button press.
bool	Key_IsGamepadKey (FKey Key)
	Returns true if the key is a gamepad button.
Input|KeyEvent
int	GetUserIndex (FKeyEvent Input)
EUINavigation	Key_GetNavigationDirectionFromKey (FKeyEvent InKeyEvent)
	Returns the navigation action corresponding to this key, or Invalid if not found.
EUINavigationAction	Key_GetNavigationActionFromKey (FKeyEvent InKeyEvent)
	Returns the navigation action corresponding to this key, or Invalid if not found.
FKey	GetKey (FKeyEvent Input)
	Returns the key for this event.
Input|ModifierKeys
bool	ModifierKeysState_IsAltDown (FSlateModifierKeysState KeysState)
	Returns true if either alt key was down when the key state was captured.
FSlateModifierKeysState	GetModifierKeysState ()
	Returns a snapshot of the cached modifier-keys state for the application.
bool	ModifierKeysState_IsCommandDown (FSlateModifierKeysState KeysState)
	Returns true if either command key was down when the key state was captured.
bool	ModifierKeysState_IsControlDown (FSlateModifierKeysState KeysState)
	Returns true if either control key was down when the key state was captured.
bool	ModifierKeysState_IsShiftDown (FSlateModifierKeysState KeysState)
	Returns true if either shift key was down when the key state was captured.
Input|MotionTracking
void	CalibrateTilt ()
	Calibrate the tilt for the input device.
Input|PointerEvent
FKey	PointerEvent_GetEffectingButton (FPointerEvent Input)
	Mouse button that caused this event to be raised (possibly FKey::Invalid).
FVector2D	PointerEvent_GetGestureDelta (FPointerEvent Input)
	Returns the change in gesture value since the last gesture event of the same type.
ESlateGesture	PointerEvent_GetGestureType (FPointerEvent Input)
	Returns the type of touch gesture.
FVector2D	PointerEvent_GetCursorDelta (FPointerEvent Input)
	Returns the distance the mouse traveled since the last event was handled.
FVector2D	PointerEvent_GetLastScreenSpacePosition (FPointerEvent Input)
	Returns the position of the cursor in screen space last time we handled an input event.
int	PointerEvent_GetPointerIndex (FPointerEvent Input)
	Returns the unique identifier of the pointer (e.g., finger index).
FVector2D	PointerEvent_GetScreenSpacePosition (FPointerEvent Input)
	Returns The position of the cursor in screen space.
int	PointerEvent_GetTouchpadIndex (FPointerEvent Input)
	Returns the index of the touch pad that generated this event (for platforms with multiple touch pads per user).
int	PointerEvent_GetUserIndex (FPointerEvent Input)
	Returns the index of the user that caused the event.
float32	PointerEvent_GetWheelDelta (FPointerEvent Input)
	How much did the mouse wheel turn since the last mouse event.
bool	PointerEvent_IsMouseButtonDown (FPointerEvent Input, FKey MouseButton)
	Mouse buttons that are currently pressed.
bool	PointerEvent_IsTouchEvent (FPointerEvent Input)
	Returns true if this event a result from a touch (as opposed to a mouse).

Variables
Variables
const FSlateModifierKeysState	ModifierKeysState

Function Documentation

CalibrateTilt()

void CalibrateTilt

(

)

Calibrate the tilt for the input device.

EqualEqual_InputChordInputChord()

bool EqualEqual_InputChordInputChord	(	FInputChord	A,
		FInputChord	B )

Test if the input chords are equal (A == B).

Parameters

A	The chord to compare against
B	The chord to compare Returns true if the chords are equal, false otherwise

EqualEqual_KeyKey()

bool EqualEqual_KeyKey	(	FKey	A,
		FKey	B )

Test if the input key are equal (A == B).

Parameters

A	The key to compare against
B	The key to compare Returns true if the key are equal, false otherwise

GetAnalogValue()

float32 GetAnalogValue

(

FAnalogInputEvent

Input

)

GetKey()

FKey GetKey

(

FKeyEvent

Input

)

Returns the key for this event.

Returns

Key name

GetModifierKeysState()

FSlateModifierKeysState GetModifierKeysState

(

)

Returns a snapshot of the cached modifier-keys state for the application.

GetUserIndex()

int GetUserIndex

(

FKeyEvent

Input

)

InputChord_GetDisplayName()

FText InputChord_GetDisplayName

(

FInputChord

Key

)

Returns

The display name of the input chord

InputEvent_IsAltDown()

bool InputEvent_IsAltDown

(

FInputEvent

Input

)

Returns true if either alt key was down when this event occurred.

InputEvent_IsCommandDown()

bool InputEvent_IsCommandDown

(

FInputEvent

Input

)

Returns true if either command key was down when this event occurred.

InputEvent_IsControlDown()

bool InputEvent_IsControlDown

(

FInputEvent

Input

)

Returns true if either control key was down when this event occurred.

InputEvent_IsLeftAltDown()

bool InputEvent_IsLeftAltDown

(

FInputEvent

Input

)

Returns true if left alt key was down when this event occurred.

InputEvent_IsLeftCommandDown()

bool InputEvent_IsLeftCommandDown

(

FInputEvent

Input

)

Returns true if left command key was down when this event occurred.

InputEvent_IsLeftControlDown()

bool InputEvent_IsLeftControlDown

(

FInputEvent

Input

)

Returns true if left control key was down when this event occurred.

InputEvent_IsLeftShiftDown()

bool InputEvent_IsLeftShiftDown

(

FInputEvent

Input

)

Returns true if left shift key was down when this event occurred.

InputEvent_IsRepeat()

bool InputEvent_IsRepeat

(

FInputEvent

Input

)

Returns whether or not this character is an auto-repeated keystroke.

InputEvent_IsRightAltDown()

bool InputEvent_IsRightAltDown

(

FInputEvent

Input

)

Returns true if right alt key was down when this event occurred.

InputEvent_IsRightCommandDown()

bool InputEvent_IsRightCommandDown

(

FInputEvent

Input

)

Returns true if right command key was down when this event occurred.

InputEvent_IsRightControlDown()

bool InputEvent_IsRightControlDown

(

FInputEvent

Input

)

Returns true if left control key was down when this event occurred.

InputEvent_IsRightShiftDown()

bool InputEvent_IsRightShiftDown

(

FInputEvent

Input

)

Returns true if right shift key was down when this event occurred.

InputEvent_IsShiftDown()

bool InputEvent_IsShiftDown

(

FInputEvent

Input

)

Returns true if either shift key was down when this event occurred.

Key_GetDisplayName()

FText Key_GetDisplayName	(	FKey	Key,
		bool	bLongDisplayName = true )

Returns the display name of the key.

Key_GetNavigationAction()

EUINavigationAction Key_GetNavigationAction

(

FKey

InKey

)

Key_GetNavigationActionFromKey()

EUINavigationAction Key_GetNavigationActionFromKey

(

FKeyEvent

InKeyEvent

)

Returns the navigation action corresponding to this key, or Invalid if not found.

Key_GetNavigationDirectionFromAnalog()

EUINavigation Key_GetNavigationDirectionFromAnalog

(

FAnalogInputEvent

InAnalogEvent

)

Returns the navigation action corresponding to this key, or Invalid if not found.

Key_GetNavigationDirectionFromKey()

EUINavigation Key_GetNavigationDirectionFromKey

(

FKeyEvent

InKeyEvent

)

Returns the navigation action corresponding to this key, or Invalid if not found.

Key_IsAnalog()

bool Key_IsAnalog

(

FKey

Key

)

Returns true if the key is an analog axis.

Key_IsAxis1D()

bool Key_IsAxis1D

(

FKey

Key

)

Returns true if the key is a 1D (float) axis.

Key_IsAxis2D()

bool Key_IsAxis2D

(

FKey

Key

)

Returns true if the key is a 2D (vector) axis.

Key_IsAxis3D()

bool Key_IsAxis3D

(

FKey

Key

)

Returns true if the key is a 3D (vector) axis.

Key_IsButtonAxis()

bool Key_IsButtonAxis

(

FKey

Key

)

Returns true if the key is a 1D axis emulating a digital button press.

Key_IsDigital()

bool Key_IsDigital

(

FKey

Key

)

Returns true if the key is a digital button press.

Key_IsGamepadKey()

bool Key_IsGamepadKey

(

FKey

Key

)

Returns true if the key is a gamepad button.

Key_IsKeyboardKey()

bool Key_IsKeyboardKey

(

FKey

Key

)

Returns true if the key is a keyboard button.

Key_IsModifierKey()

bool Key_IsModifierKey

(

FKey

Key

)

Returns true if the key is a modifier key: Ctrl, Command, Alt, Shift.

Key_IsMouseButton()

bool Key_IsMouseButton

(

FKey

Key

)

Returns true if the key is a mouse button.

Key_IsValid()

bool Key_IsValid

(

FKey

Key

)

Returns true if this is a valid key.

Key_IsVectorAxis()

bool Key_IsVectorAxis

(

FKey

Key

)

Returns true if the key is a vector axis Note: Deprecated. Use Is Axis 2D/3D instead.

ModifierKeysState_IsAltDown()

bool ModifierKeysState_IsAltDown

(

FSlateModifierKeysState

KeysState

)

Returns true if either alt key was down when the key state was captured.

ModifierKeysState_IsCommandDown()

bool ModifierKeysState_IsCommandDown

(

FSlateModifierKeysState

KeysState

)

Returns true if either command key was down when the key state was captured.

ModifierKeysState_IsControlDown()

bool ModifierKeysState_IsControlDown

(

FSlateModifierKeysState

KeysState

)

Returns true if either control key was down when the key state was captured.

ModifierKeysState_IsShiftDown()

bool ModifierKeysState_IsShiftDown

(

FSlateModifierKeysState

KeysState

)

Returns true if either shift key was down when the key state was captured.

PointerEvent_GetCursorDelta()

FVector2D PointerEvent_GetCursorDelta

(

FPointerEvent

Input

)

Returns the distance the mouse traveled since the last event was handled.

PointerEvent_GetEffectingButton()

FKey PointerEvent_GetEffectingButton

(

FPointerEvent

Input

)

Mouse button that caused this event to be raised (possibly FKey::Invalid).

PointerEvent_GetGestureDelta()

FVector2D PointerEvent_GetGestureDelta

(

FPointerEvent

Input

)

Returns the change in gesture value since the last gesture event of the same type.

PointerEvent_GetGestureType()

ESlateGesture PointerEvent_GetGestureType

(

FPointerEvent

Input

)

Returns the type of touch gesture.

PointerEvent_GetLastScreenSpacePosition()

FVector2D PointerEvent_GetLastScreenSpacePosition

(

FPointerEvent

Input

)

Returns the position of the cursor in screen space last time we handled an input event.

PointerEvent_GetPointerIndex()

int PointerEvent_GetPointerIndex

(

FPointerEvent

Input

)

Returns the unique identifier of the pointer (e.g., finger index).

PointerEvent_GetScreenSpacePosition()

FVector2D PointerEvent_GetScreenSpacePosition

(

FPointerEvent

Input

)

Returns The position of the cursor in screen space.

PointerEvent_GetTouchpadIndex()

int PointerEvent_GetTouchpadIndex

(

FPointerEvent

Input

)

Returns the index of the touch pad that generated this event (for platforms with multiple touch pads per user).

PointerEvent_GetUserIndex()

int PointerEvent_GetUserIndex

(

FPointerEvent

Input

)

Returns the index of the user that caused the event.

PointerEvent_GetWheelDelta()

float32 PointerEvent_GetWheelDelta

(

FPointerEvent

Input

)

How much did the mouse wheel turn since the last mouse event.

PointerEvent_IsMouseButtonDown()

bool PointerEvent_IsMouseButtonDown	(	FPointerEvent	Input,
		FKey	MouseButton )

Mouse buttons that are currently pressed.

PointerEvent_IsTouchEvent()

bool PointerEvent_IsTouchEvent

(

FPointerEvent

Input

)

Returns true if this event a result from a touch (as opposed to a mouse).

Variable Documentation

ModifierKeysState

const FSlateModifierKeysState ModifierKeysState