1. Epic GamesDeveloper
  3. UEnhancedInputEditorSubsystem

UEnhancedInputEditorSubsystem

The Enhanced Input Editor Subsystem can be used to process input outside of PIE within the editor.

API > API/Plugins > API/Plugins/InputEditor

Inheritance Hierarchy

References

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

Syntax

UCLASS ()  
class UEnhancedInputEditorSubsystem :  
    public UEditorSubsystem ,  
    public IEnhancedInputSubsystemInterface ,  
    public FTickableGameObject

Remarks

The Enhanced Input Editor Subsystem can be used to process input outside of PIE within the editor. Calling StartConsumingInput will allow the input preprocessor to drive Input Action delegates to be fired in the editor.

This allows you to hook up Input Action delegates in Editor Utilities to make editor tools driven by input.

Variables

  Type Name Description
Protected variable UProperty Transient TMap< TObjectPtr< const UInputAction >, FInjectedInput > ContinuouslyInjectedInputs Map of inputs that should be injected every frame. These inputs will be injected when ForcedInput is ticked.

Functions

  Type Name Description
Public function void Adds all the default mapping contexts from the UEnhancedInputEditorSettings
Public function Virtual void  
Public function Const TStatId  
Public function Virtual Const UWorld *  
Public function Virtual Const ETickableTickType  
Public function Virtual Const UWorld *  
Public function Virtual void

Initialize ( FSubsystemCollectionBase& Collection
)

  
Public function bool

InputKey ( const FInputKeyParams& Params
)

 Inputs a key on this subsystem's player input which can then be processed as normal during Tick.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool Returns true if this subsystem is currently consuming input
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function UFunction BlueprintCallable, Category bool

PopInputComponent ( UInputComponent* InInputComponent
)

 Removes this input component onto the stack to be processed by this subsystem's tick function
Public function UFunction BlueprintCallable, Category void

PushInputComponent ( UInputComponent* InInputComponent
)

 Pushes this input component onto the stack to be processed by this subsystem's tick function
Public function void Removes all the default mapping contexts from the UEnhancedInputEditorSettings
Public function Virtual Const bool

ShouldCreateSubsystem ( UObject* Outer
)

  
Public function UFunction BlueprintCallable, Category void Start the consumption of input messages in this subsystem.
Public function UFunction BlueprintCallable, Category void Tells this subsystem to stop ticking and consuming any input.
Public function Virtual void

Tick ( float DeltaTime
)

  

Overridden from IEnhancedInputSubsystemInterface

  Type Name Description
Protected function Virtual TMap< TObjectPtr< const UInputAction >, FInjectedInput > & Pure-virtual getter for the map of inputs that should be injected every frame.
Public function Virtual Const UEnhancedPlayerInput *  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page