Navigation
API > API/Plugins > API/Plugins/CommonUI > API/Plugins/CommonUI/Input
References
| Module | CommonUI |
| Header | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/Input/UIActionBinding.h |
| Include | #include "Input/UIActionBinding.h" |
Syntax
struct FUIActionBinding
Variables
| Type | Name | Description | |
|---|---|---|---|
| FText | ActionDisplayName | ||
| FName | ActionName | ||
| bool | bConsumesInput | ||
| bool | bDisplayInActionBar | ||
| bool | bIsPersistent | ||
| TWeakObjectPtr< const UWidget > | BoundWidget | ||
| FUIActionBindingHandle | Handle | ||
| TArray< FUIActionKeyMapping > | HoldMappings | ||
| TWeakObjectPtr< const UInputAction > | InputAction | ||
| EInputEvent | InputEvent | ||
| ECommonInputMode | InputMode | ||
| FDataTableRowHandle | LegacyActionTableRow | : Rename non-legacy in 5.3. We no longer have any active plans to remove data tables in CommonUI. | |
| TArray< FUIActionKeyMapping > | NormalMappings | ||
| FSimpleDelegate | OnExecuteAction | ||
| FOnHoldActionPressed | OnHoldActionPressed | ||
| FOnHoldActionProgressedMulticast | OnHoldActionProgressed | ||
| FOnHoldActionPressed | OnHoldActionReleased | ||
| TWeakPtr< FActionRouterBindingCollection > | OwningCollection |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FUIActionBinding
(
const FUIActionBinding& |
|||
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | BeginHold () |
||
| void | BeginRollback
(
float TargetHoldRollbackTime, |
||
| void | CancelHold () |
||
| void | |||
| TSharedPtr< FUIActionBinding > | FindBinding
(
FUIActionBindingHandle Handle |
||
| FCommonInputActionDataBase * | : Rename non-legacy in 5.3. We no longer have any active plans to remove data tables in CommonUI. | ||
| double | |||
| bool | IsHoldActive () |
||
| EProcessHoldActionResult | ProcessHoldInput
(
ECommonInputMode ActiveInputMode, |
||
| bool | ProcessNormalInput
(
ECommonInputMode ActiveInputMode, |
||
| void | ResetHold () |
||
| FString | |||
| FUIActionBindingHandle | TryCreate
(
const UWidget& InBoundWidget, |
||
| bool | UpdateHold
(
float TargetHoldTime |
Operators
| Type | Name | Description | |
|---|---|---|---|
| bool | operator==
(
const FUIActionBindingHandle& OtherHandle |
Typedefs
| Name | Description |
|---|---|
| FOnHoldActionPressed | |
| FOnHoldActionProgressedMulticast | |
| FOnHoldActionReleased |
Constants
| Name | Description |
|---|---|
| AllRegistrationsByHandle | |
| CurrentHoldActionKeys | All keys currently being tracked for a hold action. |
| IdCounter |