FInputChord | Unreal Engine 5.7 Documentation

An Input Chord is a key and the modifier keys that are to be held with it.


Name	FInputChord
Type	struct
Header File	/Engine/Source/Runtime/Slate/Public/Framework/Commands/InputChord.h
Include Path	#include "Framework/Commands/InputChord.h"

Syntax

USTRUCT (BlueprintType )  
struct FInputChord

Name	Remarks	Include Path
FInputChord ( FInputChord&& Other )	Move constructor.	Framework/Commands/InputChord.h
FInputChord ( const FKey InKey )		Framework/Commands/InputChord.h
FInputChord ()		Framework/Commands/InputChord.h
FInputChord ( const EModifierKey::Type InModifierKeys, const FKey InKey )	Creates and initializes a new instance.	Framework/Commands/InputChord.h
FInputChord ( const FKey InKey, const EModifierKey::Type InModifierKeys )	Creates and initializes a new instance.	Framework/Commands/InputChord.h
FInputChord ( const FKey InKey, const bool bInShift, const bool bInCtrl, const bool bInAlt, const bool bInCmd )		Framework/Commands/InputChord.h
FInputChord ( const FInputChord& Other )	Copy constructor.	Framework/Commands/InputChord.h

Name	Remarks
ERelationshipType	The ways two chords can be related to each other.

Name	Type	Remarks	Include Path	Unreal Specifiers
bAlt	uint32	Whether the alt key is part of the chord.	Framework/Commands/InputChord.h	EditAnywhere BlueprintReadWrite Category=Modifier
bCmd	uint32	Whether the command key is part of the chord.	Framework/Commands/InputChord.h	EditAnywhere BlueprintReadWrite Category=Modifier
bCtrl	uint32	Whether the control key is part of the chord.	Framework/Commands/InputChord.h	EditAnywhere BlueprintReadWrite Category=Modifier
bShift	uint32	Whether the shift key is part of the chord.	Framework/Commands/InputChord.h	EditAnywhere BlueprintReadWrite Category=Modifier
Key	FKey	The Key is the core of the chord.	Framework/Commands/InputChord.h	EditAnywhere BlueprintReadWrite Category=Key

Name	Remarks	Include Path
FText GetInputText ( const bool bLongDisplayName ) const	Gets a localized string that represents the chord.	Framework/Commands/InputChord.h
FText GetKeyText ( const bool bLongDisplayName ) const	Gets the key represented as a localized string.	Framework/Commands/InputChord.h
FText GetModifierText ( TOptional< FText > ModifierAppender ) const	Gets the localized string for the modifier portion of the coord.	Framework/Commands/InputChord.h
ERelationshipType GetRelationship ( const FInputChord& OtherChord ) const	Returns the relationship between this chord and another.	Framework/Commands/InputChord.h
bool HasAnyModifierKeys()	Checks whether this chord requires an modifier keys to be pressed.	Framework/Commands/InputChord.h
bool IsValidChord ()	Determines if this chord is valid.	Framework/Commands/InputChord.h
bool NeedsAlt()		Framework/Commands/InputChord.h
bool NeedsCommand()		Framework/Commands/InputChord.h
bool NeedsControl()		Framework/Commands/InputChord.h
bool NeedsShift()		Framework/Commands/InputChord.h
void Set ( const FInputChord& InTemplate )	Sets this chord to a new key and modifier state based on the provided template Should not be called directly.	Framework/Commands/InputChord.h

Name	Remarks	Include Path
bool operator!= ( const FInputChord& Other ) const	Compares this input chord with another for inequality.	Framework/Commands/InputChord.h
FInputChord & operator= ( const FInputChord& Other )	Copy assignment operator.	Framework/Commands/InputChord.h
FInputChord & operator= ( FInputChord&& Other )	Move assignment operator.	Framework/Commands/InputChord.h
bool operator== ( const FInputChord& Other ) const	Compares this input chord with another for equality.	Framework/Commands/InputChord.h