Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FNavigationConfig

This class is used to control which FKeys and analog axis should move focus.

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

FNavigationConfig

FNullNavigationConfig

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Framework/Application/NavigationConfig.h
Include	#include "Framework/Application/NavigationConfig.h"

Syntax

Remarks

This class is used to control which FKeys and analog axis should move focus.

Variables

	Name	Description
FKey	AnalogHorizontalKey	Which Axis Key controls horizontal navigation
float	AnalogNavigationHorizontalThreshold
float	AnalogNavigationVerticalThreshold
FKey	AnalogVerticalKey	Which Axis Key controls vertical navigation
bool	bAnalogNavigation	Should we respect the analog stick for navigation.
bool	bKeyNavigation	Should we respect keys for navigation.
bool	bTabNavigation	Should the Tab key perform next and previous style navigation.
TMap< FKey, EUI...	KeyEventRules	Digital key navigation rules.
TMap< int, FUse...	UserNavigationState	Navigation state that we store per user.

Constructors

	Name	Description
	FNavigationConfig()	Ctor

Destructors

	Name	Description
	~FNavigationConfig()	Dtor

Functions

	Name	Description
EUINavigatio...	GetNavigationActionFromKey ( const FKeyEvent& InKeyEvent )	Returns the navigation action corresponding to a key event.
EUINavigatio...	GetNavigationDirectionFromAnalog ( const FAnalogInputEvent& InAnalogE... )	Gets the navigation direction from a given analog event.
EUINavigatio...	GetNavigationDirectionFromAnalogInternal ( const FAnalogInputEvent& InAnalogE... )	Gets the navigation direction from the analog internally.
EUINavigatio...	GetNavigationDirectionFromKey ( const FKeyEvent& InKeyEvent )	Gets the navigation direction from a given key event.
float	GetRepeatRateForPressure ( float InPressure, int32 InRepeats )	Gets the repeat rate of the navigation based on the current pressure being applied.
void	OnNavigationChangedFocus ( TSharedPtr< SWidget > OldWidget, TSharedPtr< SWidget > NewWidget, FFocusEvent FocusEvent )	Notified when navigation has caused a widget change to occur
void	OnRegister()	Called when the navigation config is registered with Slate Application
void	OnUnregister()	Called when the navigation config is registered with Slate Application
void	OnUserRemoved ( int32 UserIndex )	Notified when users are removed from the system, good chance to clean up any user specific state.

Deprecated Functions

		Name	Description
	EUINavigatio...	GetNavigationActionForKey ( const FKey& InKey )	GetNavigationActionForKey doesn't handle multiple users properly, use GetNavigationActionFromKey instead

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss