FKeyDetails Struct Reference

#include <InputCoreTypes.h>

Public Types
enum	EKeyFlags {   GamepadKey = 1 << 0 , Touch = 1 << 1 , MouseButton = 1 << 2 , ModifierKey = 1 << 3 ,   NotBlueprintBindableKey = 1 << 4 , Axis1D = 1 << 5 , Axis3D = 1 << 6 , UpdateAxisWithoutSamples = 1 << 7 ,   NotActionBindableKey = 1 << 8 , Deprecated = 1 << 9 , ButtonAxis = 1 << 10 , Axis2D = 1 << 11 ,   Gesture = 1 << 12 , Virtual = 1 << 13 , NoFlags = 0 }

Public Member Functions
INPUTCORE_API	FKeyDetails (const FKey InKey, const TAttribute< FText > &InLongDisplayName, const uint32 InKeyFlags=0, const FName InMenuCategory=NAME_None, const TAttribute< FText > &InShortDisplayName=TAttribute< FText >())
INPUTCORE_API	FKeyDetails (const FKey InKey, const TAttribute< FText > &InLongDisplayName, const TAttribute< FText > &InShortDisplayName, const uint32 InKeyFlags=0, const FName InMenuCategory=NAME_None)
bool	IsModifierKey () const
bool	IsGamepadKey () const
bool	IsTouch () const
bool	IsMouseButton () const
bool	IsAxis1D () const
bool	IsAxis2D () const
bool	IsAxis3D () const
bool	IsButtonAxis () const
bool	IsAnalog () const
bool	IsDigital () const
bool	IsBindableInBlueprints () const
bool	ShouldUpdateAxisWithoutSamples () const
bool	IsBindableToActions () const
bool	IsGesture () const
bool	IsDeprecated () const
bool	IsVirtual () const
FName	GetMenuCategory () const
INPUTCORE_API FText	GetDisplayName (const bool bLongDisplayName=true) const
const FKey &	GetKey () const
EPairedAxis	GetPairedAxis () const
const FKey &	GetPairedAxisKey () const
const FKey &	GetVirtualKey () const

Friends
struct	EKeys

Member Enumeration Documentation

EKeyFlags

enum FKeyDetails::EKeyFlags

Enumerator
GamepadKey
Touch
MouseButton
ModifierKey
NotBlueprintBindableKey
Axis1D
Axis3D
UpdateAxisWithoutSamples
NotActionBindableKey
Deprecated
ButtonAxis
Axis2D
Gesture
Virtual
NoFlags

Constructor & Destructor Documentation

FKeyDetails() [1/2]

FKeyDetails::FKeyDetails	(	const FKey	InKey,
		const TAttribute< FText > &	InLongDisplayName,
		const uint32	InKeyFlags = 0,
		const FName	InMenuCategory = NAME_None,
		const TAttribute< FText > &	InShortDisplayName = TAttribute<FText>()
	)

FKeyDetails() [2/2]

FKeyDetails::FKeyDetails	(	const FKey	InKey,
		const TAttribute< FText > &	InLongDisplayName,
		const TAttribute< FText > &	InShortDisplayName,
		const uint32	InKeyFlags = 0,
		const FName	InMenuCategory = NAME_None
	)

Member Function Documentation

GetDisplayName()

FText FKeyDetails::GetDisplayName

(

const bool

bLongDisplayName = true

)

const

GetKey()

const FKey & FKeyDetails::GetKey ( ) const

inline

GetMenuCategory()

FName FKeyDetails::GetMenuCategory ( ) const

inline

GetPairedAxis()

EPairedAxis FKeyDetails::GetPairedAxis ( ) const

inline

GetPairedAxisKey()

const FKey & FKeyDetails::GetPairedAxisKey ( ) const

inline

GetVirtualKey()

const FKey & FKeyDetails::GetVirtualKey ( ) const

inline

For virtual Keys, this will return the virtual key value. For non-virtual keys, it will return the "normal" key for easier checking

IsAnalog()

bool FKeyDetails::IsAnalog ( ) const

inline

IsAxis1D()

bool FKeyDetails::IsAxis1D ( ) const

inline

IsAxis2D()

bool FKeyDetails::IsAxis2D ( ) const

inline

IsAxis3D()

bool FKeyDetails::IsAxis3D ( ) const

inline

IsBindableInBlueprints()

bool FKeyDetails::IsBindableInBlueprints ( ) const

inline

IsBindableToActions()

bool FKeyDetails::IsBindableToActions ( ) const

inline

IsButtonAxis()

bool FKeyDetails::IsButtonAxis ( ) const

inline

IsDeprecated()

bool FKeyDetails::IsDeprecated ( ) const

inline

IsDigital()

bool FKeyDetails::IsDigital ( ) const

inline

IsGamepadKey()

bool FKeyDetails::IsGamepadKey ( ) const

inline

IsGesture()

bool FKeyDetails::IsGesture ( ) const

inline

IsModifierKey()

bool FKeyDetails::IsModifierKey ( ) const

inline

IsMouseButton()

bool FKeyDetails::IsMouseButton ( ) const

inline

IsTouch()

bool FKeyDetails::IsTouch ( ) const

inline

IsVirtual()

bool FKeyDetails::IsVirtual ( ) const

inline

ShouldUpdateAxisWithoutSamples()

bool FKeyDetails::ShouldUpdateAxisWithoutSamples ( ) const

inline

Friends And Related Symbol Documentation

EKeys

friend struct EKeys

friend

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/InputCore/Classes/InputCoreTypes.h
• Engine/Source/Runtime/InputCore/Private/InputCoreTypes.cpp