1. Epic GamesDeveloper
  3. FUIActionBinding

FUIActionBinding

API > API/Plugins > API/Plugins/CommonUI

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

Syntax

struct FUIActionBinding

Constructors

Name Remarks Include Path Unreal Specifiers

FUIActionBinding ( const UWidget& InBoundWidget,
const FBindUIActionArgs& BindArgs
)

   Input/UIActionBinding.h  
  Input/UIActionBinding.h  
  Input/UIActionBinding.h  
  Input/UIActionBinding.h  

Typedefs

Name Type Remarks Include Path
FOnHoldActionPressed TMulticastDelegate_NoParams< void >   Input/UIActionBinding.h
FOnHoldActionProgressedMulticast TMulticastDelegate_OneParam< void, float >   Input/UIActionBinding.h
FOnHoldActionReleased TMulticastDelegate_NoParams< void >   Input/UIActionBinding.h

Constants

Name Type Remarks Include Path
AllRegistrationsByHandle TMap< FUIActionBindingHandle, TSharedPtr< FUIActionBinding > >   Input/UIActionBinding.h
CurrentHoldActionKeys TMap< FKey, FUIActionBindingHandle > All keys currently being tracked for a hold action. Input/UIActionBinding.h
IdCounter int32   Input/UIActionBinding.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActionDisplayName FText   Input/UIActionBinding.h  
ActionName FName   Input/UIActionBinding.h  
bConsumesInput bool   Input/UIActionBinding.h  
bDisplayInActionBar bool   Input/UIActionBinding.h  
bIsPersistent bool   Input/UIActionBinding.h  
BoundWidget TWeakObjectPtr< const UWidget >   Input/UIActionBinding.h  
Handle FUIActionBindingHandle   Input/UIActionBinding.h  
HoldMappings TArray< FUIActionKeyMapping >   Input/UIActionBinding.h  
InputAction TWeakObjectPtr< const UInputAction >   Input/UIActionBinding.h  
InputEvent EInputEvent   Input/UIActionBinding.h  
InputMode ECommonInputMode   Input/UIActionBinding.h  
InputTypesExemptFromValidKeyCheck TSet< ECommonInputType >   Input/UIActionBinding.h  
LegacyActionTableRow FDataTableRowHandle @TODO: Rename non-legacy in 5.3. We no longer have any active plans to remove data tables in CommonUI. Input/UIActionBinding.h  
NormalMappings TArray< FUIActionKeyMapping >   Input/UIActionBinding.h  
OnExecuteAction FSimpleDelegate   Input/UIActionBinding.h  
OnHoldActionPressed FOnHoldActionPressed   Input/UIActionBinding.h  
OnHoldActionProgressed FOnHoldActionProgressedMulticast   Input/UIActionBinding.h  
OnHoldActionReleased FOnHoldActionPressed   Input/UIActionBinding.h  
OwningCollection TWeakPtr< FActionRouterBindingCollection >   Input/UIActionBinding.h  
PriorityWithinCollection int32   Input/UIActionBinding.h  
UserIndex int32   Input/UIActionBinding.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
CurrentHoldSecond double At what second is the hold progress at? Input/UIActionBinding.h  
HoldProgressRollbackTickerHandle FTSTicker::FDelegateHandle Handle for ticker spawned for button hold rollback. Input/UIActionBinding.h  
HoldRollbackMultiplier double Multiplier for the time (in seconds) for hold progress to go from 1.0 (completed) to 0.0. Input/UIActionBinding.h  
HoldStartSecond double At what second will the hold start? Input/UIActionBinding.h  
HoldStartTime double At what time in seconds did the hold start? Input/UIActionBinding.h  
HoldTime double Target time (in seconds) for the hold progress to go from 0.0 to 1.0 (completed). Input/UIActionBinding.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BeginHold()

   Input/UIActionBinding.h  

void BeginRollback ( float TargetHoldRollbackTime,
float HoldTime,
FUIActionBindingHandle BindingHandle
)

   Input/UIActionBinding.h  

void CancelHold()

   Input/UIActionBinding.h  

FCommonInputActionDataBase * GetLegacyInputActionData()

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

double GetSecondsHeld()

   Input/UIActionBinding.h  

bool IsHoldActive()

   Input/UIActionBinding.h  

EProcessHoldActionResult ProcessHoldInput ( ECommonInputMode ActiveInputMode,
FKey Key,
EInputEvent InputEvent
)

   Input/UIActionBinding.h  

bool ProcessNormalInput ( ECommonInputMode ActiveInputMode,
FKey Key,
EInputEvent InputEvent
)

   Input/UIActionBinding.h  

void ResetHold()

   Input/UIActionBinding.h  

FString ToDebugString()

   Input/UIActionBinding.h  

bool UpdateHold ( float TargetHoldTime
)

   Input/UIActionBinding.h  

Static

Name Remarks Include Path Unreal Specifiers

static void CleanRegistrations()

   Input/UIActionBinding.h  

static TSharedPtr< FUIActionBinding > FindBinding ( FUIActionBindingHandle Handle
)

   Input/UIActionBinding.h  

static FUIActionBindingHandle TryCreate ( const UWidget& InBoundWidget,
const FBindUIActionArgs& BindArgs
)

   Input/UIActionBinding.h  

static FUIActionBindingHandle TryCreate ( const UWidget& InBoundWidget,
const FBindUIActionArgs& BindArgs,
int32 UserIndex
)

   Input/UIActionBinding.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FUIActionBindingHandle& OtherHandle
) const

   Input/UIActionBinding.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page