USettingObject_KeyMapping Class Reference

USettingObject_KeyMapping. More...

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from USettingObject
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Setting Object - Key Mapping
const UInputAction	m_InputAction
	The input action this key setting is associated with.
TArray< TObjectPtr< UInputAction > >	m_AdditionalInputActions
	These input actions will be bound to the same key as the input action above.
UInputMappingContext	m_InputMappingContext
	If set the mapping context will be checked for overrides for the mapping settings of the input action.
FKey	GetValue (EPlayerMappableKeySlot _Slot) const
	Returns the current value of this setting.
void	SetValue (EPlayerMappableKeySlot _Slot, FKey _NewValue, bool _CheckCollisions=true)
	Sets the value of this setting. Checks for collisions on the new key and swaps them with the current key.
FKey	GetDefaultValue (EPlayerMappableKeySlot _Slot) const
	Returns the default value of this setting.

Additional Inherited Members
bool	IsAvailable () const
	Returns if this setting is currently available, e.g. by the current display mode (will be grayer out if not).
const FSettingDescription &	GetDescription () const
	Returns the descriptive text of this setting.
const FText &	GetDisplayName () const
	Returns the display name.
ESettingsType	GetSettingsType () const
	Returns the type of this setting.
bool	HideUnavailable () const
	Whether this setting should be hidden if not available.
void	ConfirmValue ()
	To be called when the user wants to confirm the new value of this setting.
bool	IsInputModeSupported () const
	Returns if this setting is supported for the current input mode.
bool	IsPlattformSupported () const
	Returns if this setting is supported for the current platform.
bool	IsSupported () const
	Returns if this setting is even supported, e.g. by soft- or hardware (won't show up at all if not).
void	RevertToLastConfirmedValue ()
	To be called when the user wants to revert the value of this setting to the last confirmed value.
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const
FSettingDescription	m_Description
	The description of this setting.
int	m_PlatformExclusivityMask
	If any platforms are set the setting is exclusive to them and won't be shown on others.
int	m_InputAvailabilityMask
	If any Input modes are set the setting will only available when they are used, and unavailable otherwise.
const FSettingDescription	Description
	Returns the descriptive text of this setting.
const FText	DisplayName
	Returns the display name.
const ESettingsType	SettingsType
	Returns the type of this setting.
FText	m_DisplayName
	The display name of this setting.
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Detailed Description

USettingObject_KeyMapping.

A UObject encapsulating a single key mapping setting for an input action. Beware: The input mapping context still has to be registered in the EnhancedInputUserSettings in advance and afterwards the settings need to be saved explicitly!

Member Function Documentation

GetDefaultValue()

FKey GetDefaultValue

(

EPlayerMappableKeySlot

_Slot

)

const

Returns the default value of this setting.

GetValue()

FKey GetValue

(

EPlayerMappableKeySlot

_Slot

)

const

Returns the current value of this setting.

SetValue()

void SetValue	(	EPlayerMappableKeySlot	_Slot,
		FKey	_NewValue,
		bool	_CheckCollisions = true )

Sets the value of this setting. Checks for collisions on the new key and swaps them with the current key.

StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

m_AdditionalInputActions

TArray<TObjectPtr<UInputAction> > m_AdditionalInputActions

These input actions will be bound to the same key as the input action above.

m_InputAction

const UInputAction m_InputAction

The input action this key setting is associated with.

m_InputMappingContext

UInputMappingContext m_InputMappingContext

If set the mapping context will be checked for overrides for the mapping settings of the input action.