1. Epic GamesDeveloper
  3. UCommonUIActionRouterBase

UCommonUIActionRouterBase

The nucleus of the [CommonUI](API\Plugins\CommonUI\CommonUI) input routing system.

API > API/Plugins > API/Plugins/CommonUI > API/Plugins/CommonUI/Input

Inheritance Hierarchy

References

   
Module CommonUI
Header /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/Input/CommonUIActionRouterBase.h
Include #include "Input/CommonUIActionRouterBase.h"

Syntax

UCLASS&40;&41;  
class UCommonUIActionRouterBase : public ULocalPlayerSubsystem

Remarks

The nucleus of the CommonUI input routing system.

Gathers input from external sources such as game viewport client and forwards them to widgets via activatable tree node representation.

Variables

  Type Name Description
Protected variable TOptional< FUIInputConfig > ActiveInputConfig The currently applied UI input configuration
Protected variable TSharedPtr< FCommonAnalogCursor > AnalogCursor  
Protected variable bool bIsActivatableTreeEnabled  
Protected variable FTSTicker::FDelegateHandle TickHandle  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Protected function Virtual void

ApplyUIInputConfig ( const FUIInputConfig& NewConfig,
bool bForceRefresh
)

  
Public function Const bool  
Public function Static UCommonActivatableWidget *

FindOwningActivatable ( TSharedPtr< SWidget > Widget,
ULocalPlayer* OwningLocalPlayer
)

 Searches up the SWidget tree until it finds the nearest UCommonActivatableWidget
Public function void  
Protected function Const void  
Public function Const TArray< const UWidget * >  
Public function Const TArray< FUIActionBindingHandle >  
Public function Static UCommonUIActionRouterBase *

Get ( const UWidget& ContextWidget
)

  
Public function Const ECommonInputMode

GetActiveInputMode ( ECommonInputMode DefaultInputMode
)

  
Public function Const EMouseCaptureMode

GetActiveMouseCaptureMode ( EMouseCaptureMode DefaultMouseCapture
)

  
Public function Const TSharedPtr< FCommonAnalogCursor >  
Public function Const UCommonInputSubsystem &  
Public function Const int32  
Public function Const bool  
Public function Const bool  
Protected function Virtual Const TSharedRef< FCommonAnalogCursor >  
Public function void  
Public function void  
Public function Const FOnActivationMetadataChanged &  
Public function Const FOnActiveInputModeChanged &  
Public function Const FSimpleMulticastDelegate &  
Protected function Virtual void  
Public function Const ERouteUIInputResult

ProcessInput ( FKey Key,
EInputEvent InputEvent
)

  
Protected function void  
Public function void  
Public function void  
Protected function void  
Public function bool

RegisterLinkedPreprocessor ( const UWidget& Widget,
const TSharedRef< IInputProcessor >& InputPreprocessor,
int32 DesiredIndex
)

  
Public function void

RegisterScrollRecipient ( const UWidget& ScrollableWidget
)

  
Public function Virtual FUIActionBindingHandle

RegisterUIActionBinding ( const UWidget& Widget,
const FBindUIActionArgs& BindActionArgs
)

  
Public function void  
Protected function Virtual void

SetActiveRoot ( FActivatableTreeRootPtr NewActiveRoot
)

  
Public function void

SetActiveUIInputConfig ( const FUIInputConfig& NewConfig,
const UObject* InConfigSource
)

 Sets Input Config
Protected function void

SetForceResetActiveRoot ( bool bInForceResetActiveRoot
)

  
Public function Virtual void

SetIsActivatableTreeEnabled ( bool bInIsTreeEnabled
)

 Sets whether the underlying activatable tree system is enabled - when disabled, all we really do is process Persistent input actions
Public function Const bool  
Public function void

UnregisterScrollRecipient ( const UWidget& ScrollableWidget
)

  
Protected function void

UpdateLeafNodeAndConfig ( FActivatableTreeRootPtr DesiredRoot,
FActivatableTreeNodePtr DesiredLeafNode
)

  

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
Public function Virtual Const bool Override to control if the Subsystem should be created at all.

Classes

  Type Name Description
Public class FOnActivationMetadataChanged    
Public class FOnActiveInputModeChanged    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page