1. Epic GamesDeveloper
  3. UEnhancedPlayerInput

UEnhancedPlayerInput

[UEnhancedPlayerInput](API\Plugins\EnhancedInput\UEnhancedPlayerInput) : UPlayerInput extensions for enhanced player input system

API > API/Plugins > API/Plugins/EnhancedInput

Inheritance Hierarchy

References

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

Syntax

UCLASS (Config=Input, Transient)  
class UEnhancedPlayerInput : public UPlayerInput

Remarks

UEnhancedPlayerInput : UPlayerInput extensions for enhanced player input system

Variables

  Type Name Description
Protected variable uint8: 1 bIsFlushingInputThisFrame If true, then FlushPressedKeys has been called and the input key state map has been flushed.
Protected variable FName CurrentlyInUseAnyKeySubstitute If there is a key mapping to EKeys::AnyKey, we will keep track of what key was used when we first found a "Pressed" event.
Protected variable UProperty TMap< TObjectPtr< const UInputAction >, FKeyConsumptionOptions > KeyConsumptionData Array of data that represents what keys should be consumed if an enhanced input action is in a specific triggered state
Protected variable TMap< FKey, bool > KeyDownPrevious We need to grab the down states of all keys before calling Super::ProcessInputStack as it will leave bDownPrevious in the same state as bDown (i.e. this frame, not last).

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function Virtual void

EvaluateInputDelegates ( const TArray< UInputComponent* >& InputComponentStack,
const float DeltaTime,
const bool bGamePaused,
const TArray< TPair< FKey, FKeyState* > >& KeysWithEvents
)

  
Protected function Virtual void

EvaluateKeyMapState ( const float DeltaTime,
const bool bGamePaused,
OUT TArray< TPair< FKey, FKeyState* > >& KeysWithEvents
)

  
Public function Const const FInputActionInstance *

FindActionInstanceData ( TObjectPtr< const UInputAction > ForAction
)

 Returns the action instance data for the given input action if there is any.
Public function Virtual void  
Public function Const FInputActionValue

GetActionValue ( TObjectPtr< const UInputAction > ForAction
)

 Retrieve the current value of an action for this player.
Protected function Const const TMap< TObjectPtr< const UInputMappingContext >, int32 > & Note: Source reference only.
Public function Const float Returns the Time Dilation value that is currently effecting this input.
Protected function Const const TArray< FEnhancedActionKeyMapping > & This player's version of the Action Mappings
Public function void

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

 Input simulation via injection. Runs modifiers and triggers delegates as if the input had come through the underlying input system as FKeys. Applies action modifiers and triggers on top.
Public function Virtual bool

InputKey ( const FInputKeyParams& Params
)

  
Protected function Virtual Const bool

IsKeyHandledByAction ( FKey Key
)

 Causes key to be consumed if it is affecting an action.
Protected function void

NotifyInputActionsUnmapped ( const TSet< const UInputAction* >& RemovedInputActions
)

 Notifies that the given Input Actions are no longer mapped to any keys, and should have their state reset.
Public function Virtual void

ProcessInputStack ( const TArray< UInputComponent* >& InputComponentStack,
const float DeltaTime,
const bool bGamePaused
)

 Applies modifiers and triggers without affecting keys read by the base input system.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page