1. Epic GamesDeveloper
  3. UCommonInputSubsystem

UCommonInputSubsystem

API > API/Plugins > API/Plugins/CommonInput

Inheritance Hierarchy

References

   
Module CommonInput
Header /Engine/Plugins/Runtime/CommonUI/Source/CommonInput/Public/CommonInputSubsystem.h
Include #include "CommonInputSubsystem.h"

Syntax

UCLASS&40;DisplayName&61;"CommonInput"&41;  
class UCommonInputSubsystem : public ULocalPlayerSubsystem

Variables

  Type Name Description
Protected variable TSharedPtr< FCommonInputPreprocessor > CommonInputPreprocessor  
Public variable FInputMethodChangedEvent OnInputMethodChangedNative  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddOrRemoveInputTypeLock ( FName InReason,
ECommonInputType InInputType,
bool bAddLock
)

  
Protected function UFunction void  
Public function Static UCommonInputSubsystem *

Get ( const ULocalPlayer* LocalPlayer
)

  
Public function Const TObjectPtr< UCommonInputActionDomainTable >  
Public function Const UFunction BlueprintCallable, Category const FName  
Public function Const UFunction BlueprintCallable, Category ECommonInputType The current input type based on the last input received on the device.
Public function Const UFunction BlueprintCallable, Category ECommonInputType The default input type for the current platform.
Public function Const bool  
Public function Const bool Getter
Public function FGamepadChangeDetectedEvent &  
Public function Static FPlatformInputSupportOverrideDelegate & Gets the delegate that allows external systems to override which input methods are supported on this current platform.
Public function Const UFunction BlueprintCallable, Category bool  
Public function Static bool

IsMobileGamepadKey ( const FKey& InKey
)

 Returns true if the specified key can be present on both a mobile device and mobile gamepads
Public function Const UFunction BlueprintCallable, Category bool  
Protected function Const ECommonInputType

LockInput ( ECommonInputType InputToLock
)

  
Protected function Virtual TSharedPtr< FCommonInputPreprocessor >  
Public function Const bool Returns true if the current platform supports a hardware cursor
Public function void  
Public function UFunction BlueprintCallable, Category void  
Public function void

SetCursorPosition ( FVector2D NewPosition,
bool bForce
)

  
Public function UFunction BlueprintCallable, Category void

SetGamepadInputType ( const FName InGamepadInputType
)

  
Public function void

SetInputTypeFilter ( ECommonInputType InputType,
FName Reason,
bool Filter
)

  
Public function void

SetIsGamepadSimulatedClick ( bool bNewIsGamepadSimulatedClick
)

 Setter
Public function Const UFunction BlueprintCallable, Category bool Should display indicators for the current input device on screen.
Public function void

UpdateCursorPosition ( TSharedRef< FSlateUser > SlateUser,
const FVector2D& NewPosition,
bool bForce
)

  

Overridden from USubsystem

  Type Name Description
Public function Virtual void Implement this for deinitialization of instances of the system
Public function Virtual void Implement this for initialization of instances of the system

Classes

  Type Name Description
Public class FInputMethodChangedEvent    

Constants

Name Description
OnPlatformInputSupportOverride The delegate that allows external systems to override which input methods are supported on this current platform.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page