1. Epic GamesDeveloper
  3. UCommonUIActionRouterBase

UCommonUIActionRouterBase

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

API > API/Plugins > API/Plugins/CommonUI

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.

   
Name UCommonUIActionRouterBase
Type class
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/Input/CommonUIActionRouterBase.h
Include Path #include "Input/CommonUIActionRouterBase.h"

Syntax

UCLASS (MinimalAPI)  
class UCommonUIActionRouterBase : public ULocalPlayerSubsystem

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCommonUIActionRouterBase()

   Input/CommonUIActionRouterBase.h  

Classes

Name Remarks
FOnActivationMetadataChanged  
FOnActiveInputConfigChanged  
FOnActiveInputModeChanged  

Structs

Name Remarks
FActionDomainSortedRootList A wrapper around TArray that keeps RootList sorted by PaintLayer
FPendingWidgetRegistration  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActionDomainRootNodes TMap< TObjectPtr< UCommonInputActionDomain >, FActionDomainSortedRootList >   Input/CommonUIActionRouterBase.h  
ActiveActionDomainRootsPendingPaint TSet< TWeakPtr< FActivatableTreeRoot > >   Input/CommonUIActionRouterBase.h  
ActiveRootNode FActivatableTreeRootPtr   Input/CommonUIActionRouterBase.h  
bForceResetActiveRoot bool   Input/CommonUIActionRouterBase.h  
HeldKeys TArray< FKey >   Input/CommonUIActionRouterBase.h  
InputConfigSourceIndex int32   Input/CommonUIActionRouterBase.h  
InputConfigSources TCircularBuffer< FString >   Input/CommonUIActionRouterBase.h  
OnActivationMetadataChangedEvent FOnActivationMetadataChanged   Input/CommonUIActionRouterBase.h  
OnActiveInputConfigChangedEvent FOnActiveInputConfigChanged   Input/CommonUIActionRouterBase.h  
OnActiveInputModeChangedEvent FOnActiveInputModeChanged   Input/CommonUIActionRouterBase.h  
OnBoundActionsUpdatedEvent FSimpleMulticastDelegate   Input/CommonUIActionRouterBase.h  
PendingWidgetRegistrations TArray< FPendingWidgetRegistration >   Input/CommonUIActionRouterBase.h  
PersistentActions TSharedPtr< class FPersistentActionCollection > Note: Treat this as a TSharedRef - only reason it isn't is because TSharedRef doesn't play nice with forward declarations :(. Input/CommonUIActionRouterBase.h  
RebuiltWidgetsPendingNodeAssignment TArray< TWeakObjectPtr< UCommonActivatableWidget > >   Input/CommonUIActionRouterBase.h  
RootNodes TArray< FActivatableTreeRootRef >   Input/CommonUIActionRouterBase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddBinding ( FUIActionBindingHandle Binding
)

   Input/CommonUIActionRouterBase.h  

virtual bool CanProcessNormalGameInput()

   Input/CommonUIActionRouterBase.h  

void FlushInput()

   Input/CommonUIActionRouterBase.h  

TArray< const UWidget * > GatherActiveAnalogScrollRecipients()

   Input/CommonUIActionRouterBase.h  

TArray< FUIActionBindingHandle > GatherActiveBindings()

   Input/CommonUIActionRouterBase.h  

ECommonInputMode GetActiveInputMode ( ECommonInputMode DefaultInputMode
) const

   Input/CommonUIActionRouterBase.h  

EMouseCaptureMode GetActiveMouseCaptureMode ( EMouseCaptureMode DefaultMouseCapture
) const

   Input/CommonUIActionRouterBase.h  

TSharedPtr< FCommonAnalogCursor > GetCommonAnalogCursor()

   Input/CommonUIActionRouterBase.h  

UCommonInputSubsystem & GetInputSubsystem()

   Input/CommonUIActionRouterBase.h  

int32 GetLocalPlayerIndex()

   Input/CommonUIActionRouterBase.h  

bool IsPendingTreeChange()

   Input/CommonUIActionRouterBase.h  

bool IsWidgetInActiveRoot ( const UCommonActivatableWidget* Widget
) const

   Input/CommonUIActionRouterBase.h  

void NotifyUserWidgetConstructed ( const UCommonUserWidget& Widget
)

   Input/CommonUIActionRouterBase.h  

void NotifyUserWidgetDestructed ( const UCommonUserWidget& Widget
)

   Input/CommonUIActionRouterBase.h  

FOnActivationMetadataChanged & OnActivationMetadataChanged()

   Input/CommonUIActionRouterBase.h  

FOnActiveInputConfigChanged & OnActiveInputConfigChanged()

   Input/CommonUIActionRouterBase.h  

FOnActiveInputModeChanged & OnActiveInputModeChanged()

   Input/CommonUIActionRouterBase.h  

FSimpleMulticastDelegate & OnBoundActionsUpdated()

   Input/CommonUIActionRouterBase.h  

virtual ERouteUIInputResult ProcessInput ( FKey Key,
EInputEvent InputEvent
) const

   Input/CommonUIActionRouterBase.h  

void RefreshActiveRootFocus()

   Input/CommonUIActionRouterBase.h  

void RefreshActiveRootFocusRestorationTarget()

   Input/CommonUIActionRouterBase.h  

void RefreshUIInputConfig()

   Input/CommonUIActionRouterBase.h  

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

   Input/CommonUIActionRouterBase.h  

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

   Input/CommonUIActionRouterBase.h  

bool RegisterLinkedPreprocessor ( const UWidget& Widget,
const TSharedRef< IInputProcessor >& InputPreprocessor,
const FInputPreprocessorRegistrationKey& RegistrationInfo
)

   Input/CommonUIActionRouterBase.h  

void RegisterScrollRecipient ( const UWidget& ScrollableWidget
)

   Input/CommonUIActionRouterBase.h  

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

   Input/CommonUIActionRouterBase.h  

virtual void RemoveBinding ( FUIActionBindingHandle Binding
)

   Input/CommonUIActionRouterBase.h  

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

 Sets Input Config Input/CommonUIActionRouterBase.h  

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 Input/CommonUIActionRouterBase.h  

bool ShouldAlwaysShowCursor()

   Input/CommonUIActionRouterBase.h  

void UnregisterScrollRecipient ( const UWidget& ScrollableWidget
)

   Input/CommonUIActionRouterBase.h  

Overridden from USubsystem

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

   Input/CommonUIActionRouterBase.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   Input/CommonUIActionRouterBase.h  

virtual bool ShouldCreateSubsystem ( UObject* Outer
) const

   Input/CommonUIActionRouterBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void ApplyUIInputConfig ( const FUIInputConfig& NewConfig,
bool bForceRefresh
)

   Input/CommonUIActionRouterBase.h  

void FlushPressedKeys()

   Input/CommonUIActionRouterBase.h  

TWeakPtr< FActivatableTreeRoot > GetActiveRoot()

   Input/CommonUIActionRouterBase.h  

virtual TSharedRef< FCommonAnalogCursor > MakeAnalogCursor()

   Input/CommonUIActionRouterBase.h  

virtual void PostAnalogCursorCreate()

   Input/CommonUIActionRouterBase.h  

void RefreshActionDomainLeafNodeConfig()

   Input/CommonUIActionRouterBase.h  

void RegisterAnalogCursorTick()

   Input/CommonUIActionRouterBase.h  

virtual void SetActiveRoot ( FActivatableTreeRootPtr NewActiveRoot
)

   Input/CommonUIActionRouterBase.h  

void SetForceResetActiveRoot ( bool bInForceResetActiveRoot
)

   Input/CommonUIActionRouterBase.h  

void UpdateLeafNodeAndConfig ( FActivatableTreeRootPtr DesiredRoot,
FActivatableTreeNodePtr DesiredLeafNode
)

   Input/CommonUIActionRouterBase.h  

Static

Name Remarks Include Path Unreal Specifiers

static UCommonActivatableWidget * FindActivatable ( TSharedPtr< SWidget > Widget,
ULocalPlayer* OwningLocalPlayer
)

 Searches up the SWidget tree until it finds the nearest UCommonActivatableWidget (including checking Widget itself) Input/CommonUIActionRouterBase.h  

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

 Searches up the SWidget tree until it finds the nearest UCommonActivatableWidget (excluding checking Widget itself) Input/CommonUIActionRouterBase.h  

static UCommonUIActionRouterBase * Get ( const UWidget& ContextWidget
)

   Input/CommonUIActionRouterBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page