Navigation
API > API/Plugins > API/Plugins/CommonUI
A widget that shows a platform-specific icon for the given input action.
| Name | UCommonActionWidget |
| Type | class |
| Header File | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonActionWidget.h |
| Include Path | #include "CommonActionWidget.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Blueprintable)
class UCommonActionWidget : public UWidget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UCommonActionWidget
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCommonActionWidget
(
const FObjectInitializer& ObjectInitializer |
CommonActionWidget.h |
Classes
| Name | Remarks |
|---|---|
| FOnInputIconUpdated | |
| FOnInputMethodChanged |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| IconRimBrush | FSlateBrush | CommonActionWidget.h |
|
|
| OnInputIconUpdated | FOnInputIconUpdated | CommonActionWidget.h |
|
|
| OnInputMethodChanged | FOnInputMethodChanged | CommonActionWidget.h |
|
|
| ProgressMaterialBrush | FSlateBrush | The material to use when showing held progress, the progress will be sent using the material parameter defined by ProgressMaterialParam and the value will range from 0..1. | CommonActionWidget.h |
|
| ProgressMaterialParam | FName | The material parameter on ProgressMaterialBrush to update the held percentage. | CommonActionWidget.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FText GetDisplayText() |
CommonActionWidget.h |
|
|
const UInputAction * GetEnhancedInputAction() |
CommonActionWidget.h |
|
|
virtual FSlateBrush GetIcon() |
End UWidget | CommonActionWidget.h |
|
UMaterialInstanceDynamic * GetIconDynamicMaterial() |
CommonActionWidget.h |
|
|
virtual bool IsHeldAction() |
CommonActionWidget.h |
|
|
virtual void OnActionComplete() |
CommonActionWidget.h | ||
virtual void OnActionProgress
(
float HeldPercent |
CommonActionWidget.h | ||
virtual void SetEnhancedInputAction
(
UInputAction* InInputAction |
CommonActionWidget.h |
|
|
void SetHidden
(
bool bAlwaysHidden |
CommonActionWidget.h | ||
void SetIconRimBrush
(
FSlateBrush InIconRimBrush |
CommonActionWidget.h |
|
|
virtual void SetInputAction
(
FDataTableRowHandle InputActionRow |
CommonActionWidget.h |
|
|
virtual void SetInputActionBinding
(
FUIActionBindingHandle BindingHandle |
CommonActionWidget.h |
|
|
virtual void SetInputActions
(
TArray< FDataTableRowHandle > NewInputActions |
CommonActionWidget.h |
|
|
void SetProgressMaterial
(
const FSlateBrush& InProgressMaterialBrush, |
CommonActionWidget.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
CommonActionWidget.h | ||
virtual TSharedRef< SWidget > RebuildWidget() |
Begin UWidget | CommonActionWidget.h | |
virtual void SynchronizeProperties() |
CommonActionWidget.h |
Overridden from UVisual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReleaseSlateResources
(
bool bReleaseChildren |
CommonActionWidget.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Serialize
(
FArchive& Ar |
CommonActionWidget.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FCommonInputActionDataBase * GetInputActionData() |
CommonActionWidget.h | ||
UCommonInputSubsystem * GetInputSubsystem() |
CommonActionWidget.h | ||
void HandleInputMethodChanged
(
ECommonInputType InInputType |
CommonActionWidget.h | ||
void ListenToInputMethodChanged
(
bool bListen |
CommonActionWidget.h | ||
void OnEnhancedInputMappingsRebuilt() |
CommonActionWidget.h | ||
virtual bool ShouldUpdateActionWidgetIcon() |
CommonActionWidget.h | ||
virtual void UpdateActionWidget() |
CommonActionWidget.h | ||
void UpdateBindingHandleInternal
(
FUIActionBindingHandle BindingHandle |
CommonActionWidget.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnWidgetRebuilt() |
CommonActionWidget.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InputActionDataRow_DEPRECATED | FDataTableRowHandle | CommonActionWidget.h |