1. Epic GamesDeveloper
  3. FBindUIActionArgs

FBindUIActionArgs

API > API/Plugins > API/Plugins/CommonUI

   
Name FBindUIActionArgs
Type struct
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/Input/CommonUIInputTypes.h
Include Path #include "Input/CommonUIInputTypes.h"

Syntax

struct FBindUIActionArgs

Constructors

Name Remarks Include Path Unreal Specifiers

FBindUIActionArgs ( FUIActionTag InActionTag,
const FSimpleDelegate& InOnExecuteAction
)

   Input/CommonUIInputTypes.h  

FBindUIActionArgs ( const FDataTableRowHandle& InLegacyActionTableRow,
const FSimpleDelegate& InOnExecuteAction
)

 @TODO: Rename non-legacy in 5.3. We no longer have any active plans to remove data tables in CommonUI. Input/CommonUIInputTypes.h  

FBindUIActionArgs ( const UInputAction* InInputAction,
const FSimpleDelegate& InOnExecuteAction
)

   Input/CommonUIInputTypes.h  

FBindUIActionArgs ( FUIActionTag InActionTag,
bool bShouldDisplayInActionBar,
const FSimpleDelegate& InOnExecuteAction
)

   Input/CommonUIInputTypes.h  

FBindUIActionArgs ( const FDataTableRowHandle& InLegacyActionTableRow,
bool bShouldDisplayInActionBar,
const FSimpleDelegate& InOnExecuteAction
)

 @TODO: Rename non-legacy in 5.3. We no longer have any active plans to remove data tables in CommonUI. Input/CommonUIInputTypes.h  

FBindUIActionArgs ( const UInputAction* InInputAction,
bool bShouldDisplayInActionBar,
const FSimpleDelegate& InOnExecuteAction
)

   Input/CommonUIInputTypes.h  

Typedefs

Name Type Remarks Include Path
FOnHoldActionPressed TBaseDelegate_NoParams< void > If the bound action has any hold mappings, this will fire when the hold begins. Input/CommonUIInputTypes.h
FOnHoldActionProgressed TBaseDelegate_OneParam< void, float > If the bound action has any hold mappings, this will fire each frame while held. Input/CommonUIInputTypes.h
FOnHoldActionReleased TBaseDelegate_NoParams< void > If the bound action has any hold mappings, this will fire when the hold is interrupted. Input/CommonUIInputTypes.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActionTag FUIActionTag   Input/CommonUIInputTypes.h  
bConsumeInput bool True to have this binding consume the triggering key input. Input/CommonUIInputTypes.h  
bDisplayInActionBar bool Whether this binding can/should be displayed in a CommonActionBar (if one exists) Input/CommonUIInputTypes.h  
bForceHold bool True implies we will add default hold times if the current action is not a hold action Input/CommonUIInputTypes.h  
bIsPersistent bool A persistent binding is always registered and will be executed regardless of the activation status of the binding widget's parentage. Input/CommonUIInputTypes.h  
InputAction TWeakObjectPtr< const UInputAction >   Input/CommonUIInputTypes.h  
InputMode ECommonInputMode   Input/CommonUIInputTypes.h  
InputTypesExemptFromValidKeyCheck TSet< ECommonInputType > By default, the action bar only displays prompts for actions with keys valid for the current input type, any input types added here will skip that check and display this action regardless of the bound keys Input/CommonUIInputTypes.h  
KeyEvent EInputEvent   Input/CommonUIInputTypes.h  
LegacyActionTableRow FDataTableRowHandle @TODO: Rename non-legacy in 5.3. We no longer have any active plans to remove data tables in CommonUI. Input/CommonUIInputTypes.h  
OnExecuteAction FSimpleDelegate   Input/CommonUIInputTypes.h  
OnHoldActionPressed FOnHoldActionPressed   Input/CommonUIInputTypes.h  
OnHoldActionProgressed FOnHoldActionProgressed   Input/CommonUIInputTypes.h  
OnHoldActionReleased FOnHoldActionReleased   Input/CommonUIInputTypes.h  
OverrideDisplayName FText Optional display name to associate with this binding instead of the default Input/CommonUIInputTypes.h  
PriorityWithinCollection int32 Normally, actions on a widget are triggered in the order they're registered. Input/CommonUIInputTypes.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ActionHasHoldMappings()

   Input/CommonUIInputTypes.h  

FName GetActionName()

   Input/CommonUIInputTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page