Navigation
API > API/Plugins > API/Plugins/EnhancedInput
Per local player input subsystem.
| Name | UEnhancedInputLocalPlayerSubsystem |
| Type | class |
| Header File | /Engine/Plugins/EnhancedInput/Source/EnhancedInput/Public/EnhancedInputSubsystems.h |
| Include Path | #include "EnhancedInputSubsystems.h" |
Syntax
UCLASS (MinimalAPI)
class UEnhancedInputLocalPlayerSubsystem :
public ULocalPlayerSubsystem,
public IEnhancedInputSubsystemInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → ULocalPlayerSubsystem → UEnhancedInputLocalPlayerSubsystem
Implements Interfaces
Classes
| Name | Remarks |
|---|---|
| FOnControlMappingsRebuilt | A delegate that will be called when control mappings have been rebuilt this frame. |
| FOnMappingContextAdded | |
| FOnMappingContextRemoved | |
| FOnUserSettingsPostInitialized |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ControlMappingsRebuiltDelegate | FOnControlMappingsRebuilt | Blueprint Event that is called at the end of any frame that Control Mappings have been rebuilt. | EnhancedInputSubsystems.h |
|
| OnMappingContextAdded | FOnMappingContextAdded | A callback fired when a mapping context is added (AddMappingContext is called on this subsystem) | EnhancedInputSubsystems.h |
|
| OnMappingContextRemoved | FOnMappingContextRemoved | A callback fired when a mapping context is removed (RemoveMappingContext is called on this subsystem) | EnhancedInputSubsystems.h |
|
| OnPostUserSettingsInitialized | FOnUserSettingsPostInitialized | Delegate that is fired after this local player's User Settings object has been created and loaded for the first time. | EnhancedInputSubsystems.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
Begin ULocalPlayerSubsystem. | EnhancedInputSubsystems.h | |
virtual void PlayerControllerChanged
(
APlayerController* NewPlayerController |
EnhancedInputSubsystems.h |
Overridden from IEnhancedInputSubsystemInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddMappingContext
(
const UInputMappingContext* MappingContext, |
Add a control mapping context. | EnhancedInputSubsystems.h | |
virtual void ControlMappingsRebuiltThisFrame() |
Function that will be called when Control Mappings have been rebuilt this tick. | EnhancedInputSubsystems.h | |
virtual UEnhancedPlayerInput * GetPlayerInput() |
EnhancedInputSubsystems.h | ||
virtual UEnhancedInputUserSettings * GetUserSettings () |
EnhancedInputSubsystems.h | ||
virtual UserSettingClass * GetUserSettings () |
EnhancedInputSubsystems.h | ||
virtual void InitalizeUserSettings () |
Create a new user settings object if it is enabled in the EI developer settings. | EnhancedInputSubsystems.h | |
virtual void RemoveMappingContext
(
const UInputMappingContext* MappingContext, |
Remove a specific control context. This is safe to call even if the context is not applied. | EnhancedInputSubsystems.h |
Protected
Overridden from IEnhancedInputSubsystemInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TMap< TObjectPtr< const UInputAction >, FInjectedInput > & GetContinuouslyInjectedInputs () |
Pure-virtual getter for the map of inputs that should be injected every frame. | EnhancedInputSubsystems.h |