1. Epic GamesDeveloper
  3. FBindUIActionArgs

FBindUIActionArgs

API > API/Plugins > API/Plugins/CommonUI > API/Plugins/CommonUI/Input

References

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

Syntax

struct FBindUIActionArgs

Variables

  Type 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 bForceHold True implies we will add default hold times if the current action is not a hold action
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 TWeakObjectPtr< const UInputAction > InputAction  
Public variable ECommonInputMode InputMode  
Public variable EInputEvent KeyEvent  
Public variable FDataTableRowHandle LegacyActionTableRow : Rename non-legacy in 5.3. We no longer have any active plans to remove data tables in CommonUI.
Public variable FSimpleDelegate OnExecuteAction  
Public variable FOnHoldActionPressed OnHoldActionPressed  
Public variable FOnHoldActionProgressed OnHoldActionProgressed  
Public variable FOnHoldActionReleased OnHoldActionReleased  
Public variable FText OverrideDisplayName Optional display name to associate with this binding instead of the default

Constructors

  Type Name Description
Public function  

FBindUIActionArgs ( FUIActionTag InActionTag,
const FSimpleDelegate& InOnExecuteAction
)

  
Public function  

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

 : Rename non-legacy in 5.3. We no longer have any active plans to remove data tables in CommonUI.
Public function  

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

  
Public function  

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

  
Public function  

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

 : Rename non-legacy in 5.3. We no longer have any active plans to remove data tables in CommonUI.
Public function  

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

  

Functions

  Type Name Description
Public function Const bool  
Public function Const FName  

Typedefs

Name Description
FOnHoldActionPressed If the bound action has any hold mappings, this will fire when the hold begins.
FOnHoldActionProgressed If the bound action has any hold mappings, this will fire each frame while held.
FOnHoldActionReleased If the bound action has any hold mappings, this will fire when the hold is interrupted.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page