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

Light Theme

Dark Theme

UCommonActionWidget

A widget that shows a platform-specific icon for the given input action.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UCommonActionWidget

References

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

Syntax

UCLASS(BlueprintType, Blueprintable)
class UCommonActionWidget : public UWidget

Remarks

A widget that shows a platform-specific icon for the given input action.

Variables

	Name	Description
bool	bAlwaysHideOverride
FUIActionBindin...	DisplayedBindingHandle
FSlateBrush	Icon
FSlateBrush	IconRimBrush
TArray< FDataTa...	InputActions	List all the input actions that this common action widget is intended to represent.
TSharedPtr< SIm...	MyIcon
TSharedPtr< SIm...	MyIconRim
TSharedPtr< SBo...	MyKeyBox
TSharedPtr< SIm...	MyProgressImage
FOnInputMethodC...	OnInputMethodChanged
UMaterialInstan...	ProgressDynamicMaterial
FSlateBrush	ProgressMaterialBrush
FName	ProgressMaterialParam

Constructors

	Name	Description
	UCommonActionWidget ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
FText	GetDisplayText()
FSlateBrush	GetIcon()	End UWidet
const FCommo...	GetInputActionData()
UCommonInput...	GetInputSubsystem()
void	HandleInputMethodChanged ( ECommonInputType InInputType )
bool	IsHeldAction()
void	ListenToInputMethodChanged ( bool bListen )
void	OnActionComplete()
void	OnActionProgress ( float HeldPercent )
void	SetHidden ( bool bAlwaysHidden )
void	SetIconRimBrush ( FSlateBrush InIconRimBrush )
void	SetInputAction ( FDataTableRowHandle InputActionRow )
void	SetInputActionBinding ( FUIActionBindingHandle BindingHandl... )
void	SetInputActions ( TArray< FDataTableRowHandle > NewIn... )
void	SetProgressMaterial ( const FSlateBrush& InProgressMater..., const FName& InProgressMaterialPar... )
void	UpdateActionWidget()
void	UpdateBindingHandleInternal ( FUIActionBindingHandle BindingHandl... )

Overridden from UWidget

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
void	OnWidgetRebuilt()	Function called after the underlying SWidget is constructed.
TSharedRef< ...	RebuildWidget()	Begin UWidget
void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from UObject

		Name	Description
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Classes

	Name	Description
	FOnInputMethodChanged

Deprecated Variables

		Name	Description
	FDataTableRowHa...	InputActionDataRow_DEPRECATED