Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

> Unreal Engine API Reference > Plugins > CommonInput > UCommonInputSubsystem

Light Theme

Dark Theme

UCommonInputSubsystem

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USubsystem

ULocalPlayerSubsystem

UCommonInputSubsystem

References

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

Syntax

UCLASS(DisplayName="CommonInput")
class UCommonInputSubsystem : public ULocalPlayerSubsystem

Variables

		Name	Description
	FInputMethodCha...	OnInputMethodChangedNative

Constructors

	Name	Description
	UCommonInputSubsystem()

Functions

	Name	Description
void	AddOrRemoveInputTypeLock ( FName InReason, ECommonInputType InInputType, bool bAddLock )
void	BroadcastInputMethodChanged()
UCommonInput...	Get ( const ULocalPlayer* LocalPlaye... )
const FName	GetCurrentGamepadName()
ECommonInput...	GetCurrentInputType()	The current input type based on the last input received on the device.
ECommonInput...	GetDefaultInputType()	The default input type for the current platform.
bool	GetInputTypeFilter ( ECommonInputType InputType )
bool	GetIsGamepadSimulatedClick()	Getter
FGamepadChan...	GetOnGamepadChangeDetected()
FPlatformInp...	GetOnPlatformInputSupportOverride()	Gets the delegate that allows external systems to override which input methods are supported on this current platform.
bool	IsInputMethodActive ( ECommonInputType InputMethod )
bool	IsMobileGamepadKey ( const FKey& InKey )	Returns true if the specified key can be present on both a mobile device and mobile gamepads
bool	IsUsingPointerInput()
ECommonInput...	LockInput ( ECommonInputType InputToLock )
bool	PlatformSupportsHardwareCursor()	Returns true if the current platform supports a hardware cursor
void	SetCurrentInputType ( ECommonInputType NewInputType )
void	SetCursorPosition ( FVector2D NewPosition, bool bForce )
void	SetGamepadInputType ( const FName InGamepadInputType )
void	SetInputTypeFilter ( ECommonInputType InputType, FName Reason, bool Filter )
void	SetIsGamepadSimulatedClick ( bool bNewIsGamepadSimulatedClick )	Setter
bool	ShouldShowInputKeys()	Should display indicators for the current input device on screen.
void	UpdateCursorPosition ( TSharedRef< FSlateUser > SlateUser, const FVector2D& NewPosition, bool bForce )

Overridden from USubsystem

		Name	Description
	void	Deinitialize()	Implement this for deinitialization of instances of the system
	void	Initialize ( FSubsystemCollectionBase& Collecti... )	Implement this for initialization of instances of the system

Classes

	Name	Description
	FInputMethodChangedEvent

Constants

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