1. Epic GamesDeveloper
  3. UCommonInputSubsystem

UCommonInputSubsystem

API > API/Plugins > API/Plugins/CommonInput

   
Name UCommonInputSubsystem
Type class
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonInput/Public/CommonInputSubsystem.h
Include Path #include "CommonInputSubsystem.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCommonInputSubsystem()

   CommonInputSubsystem.h  

Classes

Name Remarks
FInputMethodChangedEvent  

Constants

Name Type Remarks Include Path
OnPlatformInputSupportOverride FPlatformInputSupportOverrideDelegate The delegate that allows external systems to override which input methods are supported on this current platform. CommonInputSubsystem.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnInputMethodChangedNative FInputMethodChangedEvent   CommonInputSubsystem.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ActionDomainTable TObjectPtr< UCommonInputActionDomainTable >   CommonInputSubsystem.h
  • Transient
bInputMethodLockedByThrashing bool Whether the last input type recalculation was locked out by input thrashing CommonInputSubsystem.h
  • Transient
bIsGamepadSimulatedClick bool Is the current click simulated by the gamepad's face button down/right (platform dependent) CommonInputSubsystem.h
  • Transient
CurrentInputLock TOptional< ECommonInputType >   CommonInputSubsystem.h  
CurrentInputLocks TMap< FName, ECommonInputType >   CommonInputSubsystem.h
  • Transient
CurrentInputType ECommonInputType The current effective input type after considering input locks and thrashing CommonInputSubsystem.h
  • Transient
GamepadInputType FName   CommonInputSubsystem.h
  • Transient
LastInputMethodChangeTime double   CommonInputSubsystem.h
  • Transient
LastTimeInputMethodThrashingBegan double   CommonInputSubsystem.h
  • Transient
NumberOfInputMethodChangesRecently int32   CommonInputSubsystem.h
  • Transient
OnInputMethodChanged FInputMethodChangedDelegate   CommonInputSubsystem.h
  • BlueprintAssignable
  • Category=CommonInputSubsystem
  • Meta=(AllowPrivateAccess)
RawInputType ECommonInputType The most recent input type that the user used, before considering locks and thrashing, but does consider PlatformSupportsInputType() CommonInputSubsystem.h
  • Transient
TickHandle FTSTicker::FDelegateHandle   CommonInputSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddOrRemoveInputTypeLock ( FName InReason,
ECommonInputType InInputType,
bool bAddLock
)

   CommonInputSubsystem.h  

TObjectPtr< UCommonInputActionDomainTable > GetActionDomainTable()

   CommonInputSubsystem.h  

const FName GetCurrentGamepadName()

   CommonInputSubsystem.h
  • BlueprintCallable
  • Category=CommonInputSubsystem

ECommonInputType GetCurrentInputType()

 The current input type based on the last input received on the device. CommonInputSubsystem.h
  • BlueprintCallable
  • Category=CommonInputSubsystem

ECommonInputType GetDefaultInputType()

 The default input type for the current platform. CommonInputSubsystem.h
  • BlueprintCallable
  • Category=CommonInputSubsystem

bool GetInputTypeFilter ( ECommonInputType InputType
) const

   CommonInputSubsystem.h  

bool GetIsGamepadSimulatedClick()

 Getter CommonInputSubsystem.h  

FGamepadChangeDetectedEvent & GetOnGamepadChangeDetected()

   CommonInputSubsystem.h  
Returns true if the input method changed in the last thrashing window. CommonInputSubsystem.h  

bool IsInputMethodActive ( ECommonInputType InputMethod
) const

   CommonInputSubsystem.h
  • BlueprintCallable
  • Category=CommonInputSubsystem

bool IsUsingPointerInput()

   CommonInputSubsystem.h
  • BlueprintCallable
  • Category=CommonInputSubsystem

bool PlatformSupportsHardwareCursor()

 Returns true if the current platform supports a hardware cursor CommonInputSubsystem.h  

void SetActionDomainTable ( TObjectPtr< UCommonInputActionDomainTable > Table
)

   CommonInputSubsystem.h  

void SetCurrentInputType ( ECommonInputType NewInputType
)

   CommonInputSubsystem.h
  • BlueprintCallable
  • Category=CommonInputSubsystem

void SetCursorPosition ( FVector2D NewPosition,
bool bForce
)

   CommonInputSubsystem.h  

void SetGamepadInputType ( const FName InGamepadInputType
)

   CommonInputSubsystem.h
  • BlueprintCallable
  • Category=CommonInputSubsystem

void SetInputTypeFilter ( ECommonInputType InputType,
FName Reason,
bool Filter
)

   CommonInputSubsystem.h  

void SetIsGamepadSimulatedClick ( bool bNewIsGamepadSimulatedClick
)

 Setter CommonInputSubsystem.h  
Should display indicators for the current input device on screen. CommonInputSubsystem.h
  • BlueprintCallable
  • Category=CommonInputSubsystem

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

   CommonInputSubsystem.h  

Overridden from USubsystem

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

   CommonInputSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   CommonInputSubsystem.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BroadcastInputMethodChanged()

   CommonInputSubsystem.h  

ECommonInputType LockInput ( ECommonInputType InputToLock
) const

   CommonInputSubsystem.h  

virtual TSharedPtr< FCommonInputPreprocessor > MakeInputProcessor()

   CommonInputSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static UCommonInputSubsystem * Get ( const ULocalPlayer* LocalPlayer
)

   CommonInputSubsystem.h  

static FPlatformInputSupportOverrideDelegate & GetOnPlatformInputSupportOverride ()

 Gets the delegate that allows external systems to override which input methods are supported on this current platform. CommonInputSubsystem.h  

static bool IsMobileGamepadKey ( const FKey& InKey
)

 Returns true if the specified key can be present on both a mobile device and mobile gamepads CommonInputSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page