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 5.3 Documentation

> Unreal Engine API Reference > Plugins > CommonUI > Widgets > UCommonActivatableWidgetContainerBase

Light Theme

Dark Theme

UCommonActivatableWidgetContainerBase

Base of widgets built to manage N activatable widgets, displaying one at a time.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UCommonActivatableWidgetContainerBase

	UCommonActivatableWidgetQueue
	UCommonActivatableWidgetStack

References

Module	CommonUI
Header	/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/Widgets/CommonActivatableWidgetContainer.h
Include	#include "Widgets/CommonActivatableWidgetContainer.h"

Syntax

UCLASS(Abstract)
class UCommonActivatableWidgetContainerBase : public UWidget

Remarks

Base of widgets built to manage N activatable widgets, displaying one at a time. Intentionally meant to be black boxes that do not expose child/slot modification like a normal panel widget.

Variables

	Name	Description
UCommonActivata...	DisplayedWidget
FUserWidgetPool	GeneratedWidgetsPool
TSharedPtr< SSp...	MyInputGuard
TSharedPtr< SOv...	MyOverlay
TSharedPtr< SCo...	MySwitcher
FTransitioningC...	OnTransitioningChanged
ETransitionCurv...	TransitionCurveType	The curve function type to apply to the transition animation
float	TransitionDuration	The total duration of a single transition between widgets
ECommonSwitcher...	TransitionType	The type of transition to play between widgets
TArray< UCommon...	WidgetList

Constructors

	Name	Description
	UCommonActivatableWidgetContainerBase ( const FObjectInitializer& Initiali... )

Functions

	Name	Description
ActivatableW...	AddWidget ( TSubclassOf< UCommonActivatableWidg..., TFunctionRef< void(ActivatableWidge... )	Generates (either creates or pulls from the inactive pool) instance of the given widget class and adds it to the container.
ActivatableW...	AddWidget ( TSubclassOf< UCommonActivatableWidg... )	Adds an activatable widget to the container. See BP_AddWidget for more info.
void	AddWidgetInstance ( UCommonActivatableWidget& Activata... )	Adds an activatable widget instance to the container.
void	ClearWidgets()
UCommonActiv...	GetActiveWidget()
int32	GetNumWidgets()
float	GetTransitionDuration()
const TArray...	GetWidgetList()
FOnDisplayed...	OnDisplayedWidgetChanged()
void	OnWidgetAddedToList ( UCommonActivatableWidget& AddedWid... )
void	RemoveWidget ( UCommonActivatableWidget& WidgetTo... )
void	SetSwitcherIndex ( int32 TargetIndex, bool bInstantTransition )
void	SetTransitionDuration ( float Duration )

Overridden from UWidget

		Name	Description
	void	OnWidgetRebuilt()	Function called after the underlying SWidget is constructed.
	TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Classes

	Name	Description
	FOnDisplayedWidgetChanged
	FTransitioningChanged