RealDocs

UKismetInputLibrary::Key_GetNavigationAction

function Engine Blueprint Deprecated Since unknown
Deprecated: Use Get Key Event Navigation Action instead
#include "Kismet/KismetInputLibrary.h"
Access: public Specifiers: staticBlueprintPure

Description

Returns the UI navigation action (Accept, Back, or Invalid) mapped to this key by Slate's navigation config.

Caveats & Gotchas

  • Deprecated — use Key_GetNavigationActionFromKey instead, which takes the full FKeyEvent and reports more accurate results.
  • Returns EUINavigationAction::Invalid if FSlateApplication is not initialized (e.g. dedicated server or very early startup), so a fallback default is not needed but the result must still be checked.
  • Navigation actions come from the currently active Slate navigation config, not a fixed engine-wide table, so results can differ between menu widgets that install their own config.

Signature

static EUINavigationAction Key_GetNavigationAction(const FKey& InKey);

Parameters

Name Type Description Default
InKey const FKey& The key to map to a UI navigation action.

Return Type

EUINavigationAction

Example

Legacy accept/back check (prefer the KeyEvent overload) C++
EUINavigationAction Action = UKismetInputLibrary::Key_GetNavigationAction(PressedKey);
if (Action == EUINavigationAction::Accept)
{
    ConfirmSelection();
}

Version History

Introduced in: unknown

Version Status Notes
5.6 deprecated Superseded by Key_GetNavigationActionFromKey.

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.