1. Epic GamesDeveloper
  3. UEnhancedInputWorldSubsystem

UEnhancedInputWorldSubsystem

Per world input subsystem that allows you to bind input delegates to actors without an owning Player Controller.

API > API/Plugins > API/Plugins/EnhancedInput

Inheritance Hierarchy

References

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

Syntax

UCLASS (DisplayName="Enhanced Input World Subsystem (Experimental)")  
class UEnhancedInputWorldSubsystem :  
    public UWorldSubsystem,  
    public IEnhancedInputSubsystemInterface

Remarks

Per world input subsystem that allows you to bind input delegates to actors without an owning Player Controller. This should be used when an actor needs to receive input delegates but will never have an owning Player Controller. For example, you can add input delegates to unlock a door when the user has a certain set of keys pressed. Be sure to enable input on the actor, or else the input delegates won't fire!

Note: if you do have an actor with an owning Player Controller use the local player input subsystem instead.

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.
Protected variable UProperty Transient TArray< TWeakObjectPtr< UInputComponent > > CurrentInputStack Internal. This is the current stack of InputComponents that is being processed by the PlayerInput.
Protected variable TSharedPtr< FEnhancedInputWorldProcessor > InputPreprocessor Input processor that is created on Initalize.
Protected variable UProperty TObjectPtr< UEnhancedPlayerInput > PlayerInput The player input that is processing the input within this subsystem

Functions

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

AddActorInputComponent ( AActor* Actor
)

 Adds this Actor's input component onto the stack to be processed by this subsystem's tick function
Protected function void Adds all the default mapping contexts
Public function Virtual void  
Protected function Virtual Const bool

DoesSupportWorldType ( const EWorldType::Type WorldType
)

  
Public function Virtual void

Initialize ( FSubsystemCollectionBase& Collection
)

  
Protected 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 UFunction BlueprintCallable, Category, Meta bool

RemoveActorInputComponent ( AActor* Actor
)

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

ShouldCreateSubsystem ( UObject* Outer
)

  
Protected function void

TickPlayerInput ( float DeltaTime
)

 Builds the current input stack and ticks the world subsystem's player input.

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 *  
Public function Virtual void

ShowDebugInfo ( UCanvas* Canvas
)

 Debug visualization for enhanced input local player subsystem.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page