IEnhancedInputSubsystemInterface::QueryMapKeyInContextSet

Check if a key mapping is safe to add to a collection of mapping contexts

Windows
MacOS
Linux

References

Module

EnhancedInput

Header

/Engine/Plugins/Experimental/EnhancedInput/Source/EnhancedInput/Public/EnhancedInputSubsystemInterface.h

Include

#include "EnhancedInputSubsystemInterface.h"

Source

/Engine/Plugins/Experimental/EnhancedInput/Source/EnhancedInput/Private/EnhancedInputSubsystemInterface.cpp

Syntax

[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, BlueprintCosmetic, Category="Input|Mapping Queries")
virtual EMappingQueryResult QueryMapKeyInContextSet
(
    const TArray< UInputMappingContext * > & PrioritizedActiveContexts,
    const UInputMappingContext * InputContext,
    const UInputAction * Action,
    FKey Key,
    TArray< FMappingQueryIssue > & OutIssues,
    EMappingQueryIssue BlockingIssues
)

Remarks

Check if a key mapping is safe to add to a collection of mapping contexts

This context must be present in PrioritizedActiveContexts.

Returns

Summary of resulting issues.

Parameters

Parameter

Description

PrioritizedActiveContexts

Set of mapping contexts to test against ordered by priority such that earlier entries take precedence over later ones.

InputContext

Mapping context to which the action/key mapping is intended to be applied.

Action

Action that is triggered by the key

Key

Key that will provide input values towards triggering the action

OutIssues

Issues that may cause this mapping to be invalid (at your discretion). Any potential issues will be recorded, even if not present in FatalIssues.

BlockingIssues

All issues that should be considered fatal as a bitset.

See Also

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