1. Epic GamesDeveloper
  3. UCommonActivatableWidget

UCommonActivatableWidget

The base for widgets that are capable of being "activated" and "deactivated" during their lifetime without being otherwise modified or destroyed.

API > API/Plugins > API/Plugins/CommonUI

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Meta&61;&40;DisableNativeTick&41;&41;  
class UCommonActivatableWidget : public UCommonUserWidget

Remarks

The base for widgets that are capable of being "activated" and "deactivated" during their lifetime without being otherwise modified or destroyed.

This is generally desired for one or more of the following purposes:

  • This widget can turn on/off without being removed from the hierarchy (or otherwise reconstructing the underlying SWidgets), so Construct/Destruct are insufficient
  • You'd like to be able to "go back" from this widget, whether that means back a breadcrumb, closing a modal, or something else. This is built-in here.
  • This widget's place in the hierarchy is such that it defines a meaningful node-point in the tree of activatable widgets through which input is routed to all widgets.

By default, an activatable widget:

  • Is not automatically activated upon construction
  • Does not register to receive back actions (or any other actions, for that matter)
  • If classified as a back handler, is automatically deactivated (but not destroyed) when it receives a back action

Note that removing an activatable widget from the UI (i.e. triggering Destruct()) will always deactivate it, even if the UWidget is not destroyed. Re-constructing the underlying SWidget will only result in re-activation if auto-activate is enabled.

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TSoftObjectPtr< UCommonInputActionDomain > ActionDomainOverride Enable to override the inherited ActionDomain from owning CommonActivatableWidget.
Protected variable UProperty Category, EditAnywhere, Meta ESlateVisibility ActivatedVisibility  
Protected variable UProperty Category, EditAnywhere bool bAutoActivate True to automatically activate upon construction
Protected variable UProperty Category, EditAnywhere bool bIsBackActionDisplayedInActionBar True to receive "Back" actions automatically.
Protected variable UProperty Category, EditAnywhere bool bIsBackHandler True to receive "Back" actions automatically.
Protected variable UProperty Category, EditAnywhere, Meta bool bIsModal True to have this widget be treated as a root node for input routing, regardless of its actual parentage.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bOverrideActionDomain  
Protected variable UProperty Category, EditAnywhere, Meta bool bSetVisibilityOnActivated  
Protected variable UProperty Category, EditAnywhere, Meta bool bSetVisibilityOnDeactivated  
Protected variable UProperty Category, EditAnywhere bool bSupportsActivationFocus True if this widget is a candidate to receive/route focus or specify a desired UIInputConfig when active.
Protected variable UProperty Category, EditAnywhere, Meta ESlateVisibility DeactivatedVisibility  
Protected variable UProperty Category, EditAnywhere, Meta *If false True to prefer automatically restoring focus to the widget that was focused when this widget last became the non-leafmost-active-widget.
Protected variable UProperty Category, EditAnywhere, Meta TObjectPtr< UInputMappingContext > InputMapping Optional mapping context to be applied & removed on activation & deactivation respectfully.
Protected variable UProperty Category, EditAnywhere, Meta int32 InputMappingPriority Enhanced Input priority.

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void  
Public function Const bool  
Public function UFunction BlueprintCallable, Category void Bind our visibility to the activation of another widget, useful for making mouse collisions behave similiar to console navigation w.r.t activation Will immediately update visibility based on the bound widget activation & visibilites set by SetBindVisibilities.
Protected function Const UFunction Category, Meta, BlueprintImplementableEvent UWidget * Implement to provide the desired widget to focus if/when this activatable becomes the primary active widget.
Protected function Const UFunction Category, Meta, BlueprintImplementableEvent FUIInputConfig Implement to provide the input config to use when this widget is activated.
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent bool Override in BP implementations to provide custom behavior when receiving a back action Note: Only called if native code in the base class hasn't handled it in NativeOnHandleBackAction
Public function void  
Public function UFunction BlueprintCallable, Category void  
Public function Virtual Const TOptional< FActivationMetadata > Gets custom game-specific activation metadata for this widget.
Public function TObjectPtr< UCommonInputActionDomain > Returns the widget's ActionDomain, respecting any inheritance requirements.
Public function Const UFunction BlueprintCallable, Category UWidget * Returns the desired widget to focus when this Widget Activates.
Protected function *If we simply always rely on  
Public function Virtual Const TOptional< FUIInputConfig > Gets the desired input configuration to establish when this widget activates and can receive input (i.e. all parents are also active).
Protected function void  
Protected function Virtual void  
Protected function Virtual void  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const bool

IsModal ()

  
Protected function Virtual Const UWidget * Override to provide the desired widget that should receive focus when this becomes the primary active widget.
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual bool  
Public function Const FSimpleMulticastDelegate &  
Public function Const FSimpleMulticastDelegate &  
Public function Const FSimpleMulticastDelegate &  
Public function Const FSimpleMulticastDelegate &  
Public function void

RegisterInputTreeNode ( const TSharedPtr< FActivatableTreeNode >& OwnerNode
)

  
Protected function void Ask for focus to be re-set to our current DesiredFocusTarget, but only if our node is currently the leaf-most active node (no stealing!).
Protected function void

Reset ()

  
Public function UFunction BlueprintCallable, Category, Meta void

SetBindVisibilities ( ESlateVisibility OnActivatedVisibility,
ESlateVisibility OnDeactivatedVisibility,
bool bInAllActive
)

 Visibilities to use for when bound widgets in BindVisibilityToActivation are activated.
Public function Const bool  
Public function Const bool  
Public function Const bool  

Overridden from UUserWidget

  Type Name Description
Protected function Virtual void  
Protected function Virtual void  

Overridden from UWidget

  Type Name Description
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Overridden from UVisual

  Type Name Description
Protected function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Typedefs

Name Description
FActivatableWidgetRebuildEvent  

Constants

Name Description
OnRebuilding  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page