FBindUIActionArgs

Windows
MacOS
Linux

References

Module

CommonUI

Header

/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/Input/CommonUIInputTypes.h

Include

#include "Input/CommonUIInputTypes.h"

Syntax

struct FBindUIActionArgs

Variables

Name Description

Public variable

FUIActionTag

 

ActionTag

Public variable

bool

 

bConsumeInput

True to have this binding consume the triggering key input.

Public variable

bool

 

bDisplayInActionBar

Whether this binding can/should be displayed in a CommonActionBar (if one exists)

Public variable

bool

 

bIsPersistent

A persistent binding is always registered and will be executed regardless of the activation status of the binding widget's parentage.

Public variable

ECommonInputMod...

 

InputMode

Public variable

EInputEvent

 

KeyEvent

Public variable

FDataTableRowHa...

 

LegacyActionTableRow

Public variable

FSimpleDelegate

 

OnExecuteAction

Public variable

FOnHoldActionPr...

 

OnHoldActionProgressed

Public variable

FText

 

OverrideDisplayName

Optional display name to associate with this binding instead of the default

Constructors

Name Description

Public function

FBindUIActionArgs

(
    FUIActionTag InActionTag,
    const FSimpleDelegate& InOnExecute...
)

Public function

FBindUIActionArgs

(
    const FDataTableRowHandle& InLegac...,
    const FSimpleDelegate& InOnExecute...
)

: DarenC - Remove legacy.

Public function

FBindUIActionArgs

(
    FUIActionTag InActionTag,
    bool bShouldDisplayInActionBar,
    const FSimpleDelegate& InOnExecute...
)

Public function

FBindUIActionArgs

(
    const FDataTableRowHandle& InLegac...,
    bool bShouldDisplayInActionBar,
    const FSimpleDelegate& InOnExecute...
)

: DarenC - Remove legacy.

Functions

Typedefs

Name

Description

FOnHoldActionProgressed

If the bound action has any hold mappings, this will fire each frame while held.

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