FPlayerMappableKeyQueryOptions Struct Reference

Options when querying what keys are mapped to a specific action on the player mappable key profile. More...

Public Member Functions
Functions
bool	GetbMatchBasicKeyTypes () const
	If true, then only keys that have the same value for IsGamepadKey, IsTouch, and IsGesture will be included in the results of this query.
void	SetbMatchBasicKeyTypes (bool Value)
	If true, then only keys that have the same value for IsGamepadKey, IsTouch, and IsGesture will be included in the results of this query.
bool	GetbMatchKeyAxisType () const
	If true, then only keys that have the same value of IsAxis1D, IsAxis2D, and IsAxis3D will be included in the results of this query.
void	SetbMatchKeyAxisType (bool Value)
	If true, then only keys that have the same value of IsAxis1D, IsAxis2D, and IsAxis3D will be included in the results of this query.
FPlayerMappableKeyQueryOptions &	opAssign (FPlayerMappableKeyQueryOptions Other)

Public Attributes
Query Options
FKey	KeyToMatch
	If specified, then this key will be used to match against when checking if the key types and axis are the same.
EPlayerMappableKeySlot	SlotToMatch
	The key slot that will be required to match if set. By default this is EPlayerMappableKeySlot::Unspecified, which will not filter by the slot at all.
EHardwareDevicePrimaryType	RequiredDeviceType
	If set, then only player mappings whose hardware device identifier that has the same primary input device type will be included in the results of this query.
int	RequiredDeviceFlags
	If set, then only player mappings whose Hardware Device Identifier that has the same flags as this will be included in the results.
FName	MappingName
	The mapping name to search for.
Variables
bool	bMatchKeyAxisType
bool	bMatchBasicKeyTypes

Detailed Description

Options when querying what keys are mapped to a specific action on the player mappable key profile.

Member Function Documentation

GetbMatchBasicKeyTypes()

bool GetbMatchBasicKeyTypes

(

)

const

If true, then only keys that have the same value for IsGamepadKey, IsTouch, and IsGesture will be included in the results of this query.

GetbMatchKeyAxisType()

bool GetbMatchKeyAxisType

(

)

const

If true, then only keys that have the same value of IsAxis1D, IsAxis2D, and IsAxis3D will be included in the results of this query.

opAssign()

FPlayerMappableKeyQueryOptions & opAssign

(

FPlayerMappableKeyQueryOptions

Other

)

SetbMatchBasicKeyTypes()

void SetbMatchBasicKeyTypes

(

bool

Value

)

If true, then only keys that have the same value for IsGamepadKey, IsTouch, and IsGesture will be included in the results of this query.

SetbMatchKeyAxisType()

void SetbMatchKeyAxisType

(

bool

Value

)

If true, then only keys that have the same value of IsAxis1D, IsAxis2D, and IsAxis3D will be included in the results of this query.

Member Data Documentation

bMatchBasicKeyTypes

bool bMatchBasicKeyTypes

bMatchKeyAxisType

bool bMatchKeyAxisType

KeyToMatch

FKey KeyToMatch

If specified, then this key will be used to match against when checking if the key types and axis are the same.

MappingName

FName MappingName

The mapping name to search for.

RequiredDeviceFlags

int RequiredDeviceFlags

If set, then only player mappings whose Hardware Device Identifier that has the same flags as this will be included in the results.

RequiredDeviceType

EHardwareDevicePrimaryType RequiredDeviceType

If set, then only player mappings whose hardware device identifier that has the same primary input device type will be included in the results of this query.

SlotToMatch

EPlayerMappableKeySlot SlotToMatch

The key slot that will be required to match if set. By default this is EPlayerMappableKeySlot::Unspecified, which will not filter by the slot at all.