FMapPlayerKeyArgs Struct Reference

Arguments that can be used when mapping a player key. More...

Public Member Functions
Functions
bool	GetbCreateMatchingSlotIfNeeded () const
	If there is not a player mapping already with the same Slot and Hardware Device ID, then create a new mapping for this slot.
void	SetbCreateMatchingSlotIfNeeded (bool Value)
	If there is not a player mapping already with the same Slot and Hardware Device ID, then create a new mapping for this slot.
bool	GetbDeferOnSettingsChangedBroadcast () const
	Defers setting changed delegates until the next frame if set to true.
void	SetbDeferOnSettingsChangedBroadcast (bool Value)
	Defers setting changed delegates until the next frame if set to true.
FMapPlayerKeyArgs &	opAssign (FMapPlayerKeyArgs Other)

Public Attributes
Enhanced Input|User Settings
EPlayerMappableKeySlot	Slot
	What slot this key mapping is for.
FKey	NewKey
	The new Key that this should be mapped to.
FName	HardwareDeviceId
	An OPTIONAL specifier about what kind of hardware this mapping is for.
FGameplayTag	ProfileId
	The Key Mapping Profile identifier that this mapping should be set on. If this is empty, then the currently equipped profile will be used.
FName	MappingName
	The name of the mapping for this key. This is either the default mapping name from an Input Action asset, or one that is overridden in the Input Mapping Context.
Variables
bool	bDeferOnSettingsChangedBroadcast
bool	bCreateMatchingSlotIfNeeded

Detailed Description

Arguments that can be used when mapping a player key.

Member Function Documentation

GetbCreateMatchingSlotIfNeeded()

bool GetbCreateMatchingSlotIfNeeded

(

)

const

If there is not a player mapping already with the same Slot and Hardware Device ID, then create a new mapping for this slot.

GetbDeferOnSettingsChangedBroadcast()

bool GetbDeferOnSettingsChangedBroadcast

(

)

const

Defers setting changed delegates until the next frame if set to true.

opAssign()

FMapPlayerKeyArgs & opAssign

(

FMapPlayerKeyArgs

Other

)

SetbCreateMatchingSlotIfNeeded()

void SetbCreateMatchingSlotIfNeeded

(

bool

Value

)

If there is not a player mapping already with the same Slot and Hardware Device ID, then create a new mapping for this slot.

SetbDeferOnSettingsChangedBroadcast()

void SetbDeferOnSettingsChangedBroadcast

(

bool

Value

)

Defers setting changed delegates until the next frame if set to true.

Member Data Documentation

bCreateMatchingSlotIfNeeded

bool bCreateMatchingSlotIfNeeded

bDeferOnSettingsChangedBroadcast

bool bDeferOnSettingsChangedBroadcast

HardwareDeviceId

FName HardwareDeviceId

An OPTIONAL specifier about what kind of hardware this mapping is for.

MappingName

FName MappingName

The name of the mapping for this key. This is either the default mapping name from an Input Action asset, or one that is overridden in the Input Mapping Context.

NewKey

FKey NewKey

The new Key that this should be mapped to.

ProfileId

FGameplayTag ProfileId

The Key Mapping Profile identifier that this mapping should be set on. If this is empty, then the currently equipped profile will be used.

Slot

EPlayerMappableKeySlot Slot

What slot this key mapping is for.