FKey Struct Reference

#include <InputCoreTypes.h>

Public Member Functions
	FKey ()
	FKey (const FName InName)
	FKey (const TCHAR *InName)
	FKey (const ANSICHAR *InName)
INPUTCORE_API bool	IsValid () const
INPUTCORE_API bool	IsModifierKey () const
INPUTCORE_API bool	IsGamepadKey () const
INPUTCORE_API bool	IsTouch () const
INPUTCORE_API bool	IsMouseButton () const
INPUTCORE_API bool	IsButtonAxis () const
INPUTCORE_API bool	IsAxis1D () const
INPUTCORE_API bool	IsAxis2D () const
INPUTCORE_API bool	IsAxis3D () const
INPUTCORE_API bool	IsDigital () const
INPUTCORE_API bool	IsAnalog () const
INPUTCORE_API bool	IsVirtual () const
INPUTCORE_API bool	IsBindableInBlueprints () const
INPUTCORE_API bool	ShouldUpdateAxisWithoutSamples () const
INPUTCORE_API bool	IsBindableToActions () const
INPUTCORE_API bool	IsDeprecated () const
INPUTCORE_API bool	IsGesture () const
INPUTCORE_API FText	GetDisplayName (bool bLongDisplayName=true) const
INPUTCORE_API FString	ToString () const
INPUTCORE_API FName	GetFName () const
INPUTCORE_API FName	GetMenuCategory () const
INPUTCORE_API EPairedAxis	GetPairedAxis () const
INPUTCORE_API FKey	GetPairedAxisKey () const
INPUTCORE_API FKey	GetVirtualKey () const
INPUTCORE_API bool	IsSameResolvedKey (const FKey &Other) const
INPUTCORE_API bool	SerializeFromMismatchedTag (struct FPropertyTag const &Tag, FStructuredArchive::FSlot Slot)
INPUTCORE_API bool	ExportTextItem (FString &ValueStr, FKey const &DefaultValue, UObject *Parent, int32 PortFlags, UObject *ExportRootScope) const
INPUTCORE_API bool	ImportTextItem (const TCHAR *&Buffer, int32 PortFlags, UObject *Parent, FOutputDevice *ErrorText)
INPUTCORE_API void	PostSerialize (const FArchive &Ar)
INPUTCORE_API void	PostScriptConstruct ()

Static Public Attributes
static INPUTCORE_API const TCHAR *	SyntheticCharPrefix = TEXT("UnknownCharCode_")

Friends
struct	EKeys
bool	operator== (const FKey &KeyA, const FKey &KeyB)
bool	operator!= (const FKey &KeyA, const FKey &KeyB)
bool	operator< (const FKey &KeyA, const FKey &KeyB)
uint32	GetTypeHash (const FKey &Key)

Constructor & Destructor Documentation

FKey() [1/4]

FKey::FKey ( )

inline

FKey() [2/4]

FKey::FKey ( const FName  InName )

inline

FKey() [3/4]

FKey::FKey ( const TCHAR *  InName )

inline

FKey() [4/4]

FKey::FKey ( const ANSICHAR *  InName )

inline

Member Function Documentation

ExportTextItem()

bool FKey::ExportTextItem	(	FString &	ValueStr,
		FKey const &	DefaultValue,
		UObject *	Parent,
		int32	PortFlags,
		UObject *	ExportRootScope
	)		const

GetDisplayName()

FText FKey::GetDisplayName

(

bool

bLongDisplayName = true

)

const

GetFName()

FName FKey::GetFName

(

)

const

GetMenuCategory()

FName FKey::GetMenuCategory

(

)

const

GetPairedAxis()

EPairedAxis FKey::GetPairedAxis

(

)

const

GetPairedAxisKey()

FKey FKey::GetPairedAxisKey

(

)

const

GetVirtualKey()

FKey FKey::GetVirtualKey

(

)

const

ImportTextItem()

bool FKey::ImportTextItem	(	const TCHAR *&	Buffer,
		int32	PortFlags,
		UObject *	Parent,
		FOutputDevice *	ErrorText
	)

IsAnalog()

bool FKey::IsAnalog

(

)

const

IsAxis1D()

bool FKey::IsAxis1D

(

)

const

IsAxis2D()

bool FKey::IsAxis2D

(

)

const

IsAxis3D()

bool FKey::IsAxis3D

(

)

const

IsBindableInBlueprints()

bool FKey::IsBindableInBlueprints

(

)

const

IsBindableToActions()

bool FKey::IsBindableToActions

(

)

const

IsButtonAxis()

bool FKey::IsButtonAxis

(

)

const

IsDeprecated()

bool FKey::IsDeprecated

(

)

const

IsDigital()

bool FKey::IsDigital

(

)

const

IsGamepadKey()

bool FKey::IsGamepadKey

(

)

const

IsGesture()

bool FKey::IsGesture

(

)

const

IsModifierKey()

bool FKey::IsModifierKey

(

)

const

IsMouseButton()

bool FKey::IsMouseButton

(

)

const

IsSameResolvedKey()

bool FKey::IsSameResolvedKey

(

const FKey &

Other

)

const

Parameters

Other

The key to compare against

Returns

True if this FKey's name or its virtual key name (if it has one) is the same as the other.

IsTouch()

bool FKey::IsTouch

(

)

const

IsValid()

UE_ENABLE_OPTIMIZATION_SHIP bool FKey::IsValid

(

)

const

IsVirtual()

bool FKey::IsVirtual

(

)

const

PostScriptConstruct()

void FKey::PostScriptConstruct

(

)

PostSerialize()

void FKey::PostSerialize

(

const FArchive &

Ar

)

SerializeFromMismatchedTag()

bool FKey::SerializeFromMismatchedTag	(	struct FPropertyTag const &	Tag,
		FStructuredArchive::FSlot	Slot
	)

ShouldUpdateAxisWithoutSamples()

bool FKey::ShouldUpdateAxisWithoutSamples

(

)

const

ToString()

FString FKey::ToString

(

)

const

Friends And Related Symbol Documentation

EKeys

friend struct EKeys

friend

GetTypeHash

uint32 GetTypeHash ( const FKey &  Key )

friend

operator!=

bool operator!= ( const FKey &  KeyA, const FKey &  KeyB  )

friend

operator<

bool operator< ( const FKey &  KeyA, const FKey &  KeyB  )

friend

operator==

bool operator== ( const FKey &  KeyA, const FKey &  KeyB  )

friend

Member Data Documentation

SyntheticCharPrefix

const TCHAR * FKey::SyntheticCharPrefix = TEXT("UnknownCharCode_")

static

---

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