Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UCommonActionWidget

UCommonActionWidget

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

API > API/Plugins > API/Plugins/CommonUI

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, Blueprintable&41;  
class UCommonActionWidget : public UWidget

Remarks

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

Variables

  Type Name Description
Protected variable bool bAlwaysHideOverride  
Protected variable FUIActionBindingHandle DisplayedBindingHandle  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TObjectPtr< class UInputAction > EnhancedInputAction Input Action this common action widget is intended to represent. Optional if using EnhancedInputs
Protected variable FSlateBrush Icon  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FSlateBrush IconRimBrush  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TArray< FDataTableRowHandle > InputActions List all the input actions that this common action widget is intended to represent.
Protected variable TSharedPtr< SImage > MyIcon  
Protected variable TSharedPtr< SImage > MyIconRim  
Protected variable TSharedPtr< SBox > MyKeyBox  
Protected variable TSharedPtr< SImage > MyProgressImage  
Public variable UProperty Category BlueprintAssignable FOnInputMethodChanged OnInputMethodChanged  
Protected variable UProperty Transient TObjectPtr< UMaterialInstanceDynamic > ProgressDynamicMaterial  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FSlateBrush ProgressMaterialBrush 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.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FName ProgressMaterialParam The material parameter on ProgressMaterialBrush to update the held percentage.

Constructors

  Type Name Description
Public function  

UCommonActionWidget ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category FText  
Public function Virtual Const UFunction BlueprintCallable, Category FSlateBrush

GetIcon ()

 End UWidet
Protected function Const const FCommonInputActionDataBase *  
Protected function Const UCommonInputSubsystem *  
Protected function void  
Public function Const UFunction BlueprintCallable, Category bool  
Protected function void

ListenToInputMethodChanged ( bool bListen
)

  
Public function void  
Public function void

OnActionProgress ( float HeldPercent
)

  
Public function UFunction BlueprintCallable, Category void  
Public function void

SetHidden ( bool bAlwaysHidden
)

  
Public function UFunction BlueprintCallable, Category void

SetIconRimBrush ( FSlateBrush InIconRimBrush
)

  
Public function UFunction BlueprintCallable, Category void

SetInputAction ( FDataTableRowHandle InputActionRow
)

  
Public function void  
Public function UFunction BlueprintCallable, Category void

SetInputActions ( TArray< FDataTableRowHandle > NewInputActions
)

  
Public function void

SetProgressMaterial ( const FSlateBrush& InProgressMaterialBrush,
const FName& InProgressMaterialParam
)

  
Protected function void  
Protected function void  

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual void Function called after the underlying SWidget is constructed.
Public function Virtual TSharedRef< SWidget > Begin UWidget
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public class FOnInputMethodChanged    

Deprecated Variables

  Type Name Description
Protected variable UProperty FDataTableRowHandle InputActionDataRow_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page