UCommonActionWidget

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

CommonUI

Header

/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonActionWidget.h

Include

#include "CommonActionWidget.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable)
class UCommonActionWidget : public UWidget

Variables

Name Description

Protected variable

bool

 

bAlwaysHideOverride

Protected variable

FUIActionBindin...

 

DisplayedBindingHandle

Protected variable

FSlateBrush

 

Icon

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FSlateBrush

 

IconRimBrush

Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

TArray< FDataTa...

 

InputActions

List all the input actions that this common action widget is intended to represent.

Protected variable

TSharedPtr< SIm...

 

MyIcon

Protected variable

TSharedPtr< SIm...

 

MyIconRim

Protected variable

TSharedPtr< SBo...

 

MyKeyBox

Protected variable

TSharedPtr< SIm...

 

MyProgressImage

Public variable UProperty Category BlueprintAssignable

FOnInputMethodC...

 

OnInputMethodChanged

Protected variable UProperty Transient

UMaterialInstan...

 

ProgressDynamicMaterial

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FSlateBrush

 

ProgressMaterialBrush

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FName

 

ProgressMaterialParam

Constructors

Name Description

Public function

UCommonActionWidget

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const UFunction BlueprintCallable, Category

FText

 

GetDisplayText()

Public function Const UFunction BlueprintCallable, Category

FSlateBrush

 

GetIcon()

End UWidet

Protected function Const

const FCommo...

 

GetInputActionData()

Protected function Const

UCommonInput...

 

GetInputSubsystem()

Protected function

void

 

HandleInputMethodChanged

(
    ECommonInputType InInputType
)

Public function Const UFunction BlueprintCallable, Category

bool

 

IsHeldAction()

Protected function

void

 

ListenToInputMethodChanged

(
    bool bListen
)

Public function

void

 

OnActionComplete()

Public function

void

 

OnActionProgress

(
    float HeldPercent
)

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

 

SetInputActionBinding

(
    FUIActionBindingHandle BindingHandl...
)

Public function UFunction BlueprintCallable, Category

void

 

SetInputActions

(
    TArray< FDataTableRowHandle > NewIn...
)

Public function

void

 

SetProgressMaterial

(
    const FSlateBrush& InProgressMater...,
    const FName& InProgressMaterialPar...
)

Protected function

void

 

UpdateActionWidget()

Protected function

void

 

UpdateBindingHandleInternal

(
    FUIActionBindingHandle BindingHandl...
)

Overridden from UWidget

Name Description

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Protected function Virtual

void

 

OnWidgetRebuilt()

Function called after the underlying SWidget is constructed.

Public function Virtual

TSharedRef< ...

 

RebuildWidget()

Begin UWidget

Public function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Overridden from UVisual

Name Description

Public function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Overridden from UObject

Name Description

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Classes

Name

Description

Public class

FOnInputMethodChanged

Deprecated Variables

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss