1. Epic GamesDeveloper
  3. IEnhancedInputSubsystemInterface

IEnhancedInputSubsystemInterface

Includes native functionality shared between all subsystems.

API > API/Plugins > API/Plugins/EnhancedInput

Inheritance Hierarchy

References

   
Module EnhancedInput
Header /Engine/Plugins/EnhancedInput/Source/EnhancedInput/Public/EnhancedInputSubsystemInterface.h
Include #include "EnhancedInputSubsystemInterface.h"

Syntax

class IEnhancedInputSubsystemInterface

Remarks

Includes native functionality shared between all subsystems.

Variables

  Type Name Description
Public variable PRAGMA_DISABLE_DEPRECATION_WARNINGS AutoCreateRefTerm  
Public variable   AutoCreateRefTerm  
Public variable PRAGMA_DISABLE_DEPRECATION_WARNINGS DeprecationMessage  
Public variable PRAGMA_DISABLE_DEPRECATION_WARNINGS DisplayName  
Public variable   DisplayName  

Functions

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category, Meta blueprintcosmetic void

AddMappingContext ( const UInputMappingContext* MappingContext,
int32 Priority,
const FModifyContextOptions& Options
)

 Add a control mapping context.
Protected function Virtual void Binds to any delegates of interest on the UEnhancedInputUserSettings if they are enabled in the developer settings.
Public function Virtual UFunction BlueprintCallable, Category blueprintcosmetic void Remove all applied mapping contexts.
Protected function Virtual void Function that will be called when Control Mappings have been rebuilt this tick.
Public function Virtual Const UFunction BlueprintCallable, Category blueprintcosmetic TArray< FEnhancedActionKeyMapping > Get an array of the currently applied key mappings that are marked as Player Mappable.
Public function Const UEnhancedPlayerInput *  
Public function Virtual Const UFunction BlueprintCallable, Category, Meta UEnhancedInputUserSettings *  
Protected function void Called each tick from the Enhanced Input module.
Public function Virtual Const bool

HasMappingContext ( const UInputMappingContext* MappingContext
)

 Check if a mapping context is applied to this subsystem's owner.
Public function Virtual Const UFunction BlueprintCallable, Category blueprintcosmetic bool

HasMappingContext ( const UInputMappingContext* MappingContext,
int32& OutFoundPriority
)

 Check if a mapping context is applied to this subsystem's owner.
Protected function Virtual void Create a new user settings object if it is enabled in the EI developer settings.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

InjectInputForAction ( const UInputAction* Action,
FInputActionValue RawValue,
const TArray< UInputModifier* >& Modifiers,
const TArray< UInputTrigger* >& Triggers
)

 Input simulation via injection.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

InjectInputForPlayerMapping ( const FName MappingName,
FInputActionValue RawValue,
const TArray< UInputModifier* >& Modifiers,
const TArray< UInputTrigger* >& Triggers
)

 Input simulation via injection.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

InjectInputVectorForAction ( const UInputAction* Action,
FVector Value,
const TArray< UInputModifier* >& Modifiers,
const TArray< UInputTrigger* >& Triggers
)

 Input simulation via injection.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

InjectInputVectorForPlayerMapping ( const FName MappingName,
FVector Value,
const TArray< UInputModifier* >& Modifiers,
const TArray< UInputTrigger* >& Triggers
)

 Input simulation via injection.
Protected function Virtual UFunction void A callback for when the user has applied a new mappable key profile.
Protected function Virtual UFunction void Callback for when any Enhanced Input user settings have been changed (a new key mapping for example)
Public function Virtual Const UFunction BlueprintCallable, Category blueprintcosmetic TArray< FKey > Returns the keys mapped to the given action in the active input mapping contexts.
Public function Virtual UFunction BlueprintCallable, Category blueprintcosmetic EMappingQueryResult

QueryMapKeyInActiveContextSet ( const UInputMappingContext* InputContext,
const UInputAction* Action,
FKey Key,
TArray< FMappingQueryIssue >& OutIssues,
EMappingQueryIssue BlockingIssues
)

 Check if a key mapping is safe to add to a given mapping context within the set of active contexts currently applied to the player controller.
Public function Virtual UFunction BlueprintCallable, Category blueprintcosmetic EMappingQueryResult

QueryMapKeyInContextSet ( const TArray< UInputMappingContext* >& PrioritizedActiveContexts,
const UInputMappingContext* InputContext,
const UInputAction* Action,
FKey Key,
TArray< FMappingQueryIssue >& OutIssues,
EMappingQueryIssue BlockingIssues
)

 Check if a key mapping is safe to add to a collection of mapping contexts
Public function Virtual UFunction BlueprintCallable, Category, Meta blueprintcosmetic void

RemoveMappingContext ( const UInputMappingContext* MappingContext,
const FModifyContextOptions& Options
)

 Remove a specific control context. This is safe to call even if the context is not applied.
Public function Virtual UFunction BlueprintCallable, Category, Meta blueprintcosmetic void Flag player for reapplication of all mapping contexts at the end of this frame.
Protected function void

ShowMappingContextDebugInfo ( UCanvas* Canvas,
const UEnhancedPlayerInput* PlayerInput
)

 Helper function to display debug about mapping context info
Public function Virtual UFunction BlueprintCallable, Category, Meta void

StartContinuousInputInjectionForAction ( const UInputAction* Action,
FInputActionValue RawValue,
const TArray< UInputModifier* >& Modifiers,
const TArray< UInputTrigger* >& Triggers
)

 Starts simulation of input via injection.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

StartContinuousInputInjectionForPlayerMapping ( const FName MappingName,
FInputActionValue RawValue,
const TArray< UInputModifier* >& Modifiers,
const TArray< UInputTrigger* >& Triggers
)

 Starts simulation of input via injection.
Public function Virtual UFunction BlueprintCallable, Category void Stops continuous input injection for the given action.
Public function Virtual UFunction BlueprintCallable, Category void Stops continuous input injection for the given player mapping name.
Protected function void

TickForcedInput ( float DeltaTime
)

 Ticks any forced/injected input to the subsystem's player input.

Deprecated Variables

  Type Name Description
Public variable PRAGMA_DISABLE_DEPRECATION_WARNINGS DeprecatedFunction K2_AddPlayerMappedKeyInSlot has been deprecated, please use UEnhancedInputUserSettings instead.
Public variable   DeprecatedFunction RemovePlayerMappedKeyInSlot has been deprecated, please use UEnhancedInputUserSettings instead.
Public variable   DeprecationMessage RemovePlayerMappedKeyInSlot has been deprecated, please use UEnhancedInputUserSettings instead.

Deprecated Functions

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category, Meta blueprintcosmetic void

AddPlayerMappableConfig ( const UPlayerMappableInputConfig* Config,
const FModifyContextOptions& Options
)

 RemoveAllPlayerMappedKeys has been deprecated, please use UEnhancedInputUserSettings instead.
Public function Virtual int32

AddPlayerMappedKey ( const FName MappingName,
const FKey NewKey,
const FModifyContextOptions& Options
)

 AddPlayerMappedKey has been deprecated, please use AddPlayerMappedKeyInSlot instead.
Public function Virtual int32

AddPlayerMappedKeyInSlot ( const FName MappingName,
const FKey NewKey,
const FPlayerMappableKeySlot& KeySlot,
const FModifyContextOptions& Options
)

 AddPlayerMappedKeyInSlot has been deprecated, please use UEnhancedInputUserSettings instead.
Public function Virtual Const UFunction BlueprintCallable, Category, Meta blueprintcosmetic TArray< FKey >

GetAllPlayerMappedKeys ( const FName MappingName
)

 GetAllPlayerMappedKeys has been deprecated, please use UEnhancedInputUserSettings instead.
Public function Virtual Const FKey

GetPlayerMappedKey ( const FName MappingName
)

 GetPlayerMappedKey has been deprecated, please use GetPlayerMappedKeyInSlot instead.
Public function Virtual Const FKey

GetPlayerMappedKeyInSlot ( const FName MappingName,
const FPlayerMappableKeySlot& KeySlot
)

 RemovePlayerMappedKeyInSlot has been deprecated, please use UEnhancedInputUserSettings instead.
Public function Virtual UFunction BlueprintCallable, Category, Meta blueprintcosmetic void RemoveAllPlayerMappedKeys has been deprecated, please use UEnhancedInputUserSettings instead.
Public function Virtual UFunction BlueprintCallable, Category, Meta blueprintcosmetic void

RemovePlayerMappableConfig ( const UPlayerMappableInputConfig* Config,
const FModifyContextOptions& Options
)

 RemoveAllPlayerMappedKeys has been deprecated, please use UEnhancedInputUserSettings instead.
Public function Virtual int32

RemovePlayerMappedKey ( const FName MappingName,
const FModifyContextOptions& Options
)

 RemovePlayerMappedKey has been deprecated, please use RemovePlayerMappedKeyInSlot instead.
Public function Virtual int32

RemovePlayerMappedKeyInSlot ( const FName MappingName,
const FPlayerMappableKeySlot& KeySlot,
const FModifyContextOptions& Options
)

 RemovePlayerMappedKeyInSlot has been deprecated, please use UEnhancedInputUserSettings instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page