Navigation
API > API/Plugins > API/Plugins/CommonUI
| Name | FUIActionBindingHandle |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/Input/UIActionBindingHandle.h |
| Include Path | #include "Input/UIActionBindingHandle.h" |
Syntax
USTRUCT (BlueprintType , DisplayName="UI Action Binding Handle")
struct FUIActionBindingHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Input/UIActionBindingHandle.h | |||
FUIActionBindingHandle
(
int32 InRegistrationId |
Input/UIActionBindingHandle.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CachedDebugActionName | FString | Using FString since the FName visualizer gets confused after live coding atm. | Input/UIActionBindingHandle.h | |
| RegistrationId | int32 | Input/UIActionBindingHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FName GetActionName() |
Input/UIActionBindingHandle.h | ||
ULocalPlayer * GetBoundLocalPlayer() |
Input/UIActionBindingHandle.h | ||
const UWidget * GetBoundWidget() |
Input/UIActionBindingHandle.h | ||
bool GetDisplayInActionBar() |
Input/UIActionBindingHandle.h | ||
FText GetDisplayName() |
Input/UIActionBindingHandle.h | ||
bool IsValid() |
Input/UIActionBindingHandle.h | ||
void ResetHold() |
Calls ResetHold() on the Action Binding, which in turn resets the hold progress to 0.0 | Input/UIActionBindingHandle.h | |
void SetDisplayInActionBar
(
const bool bDisplayInActionBar |
Should not be called often as broadcasts UCommonUIActionRouterBase::OnBoundActionsUpdated event | Input/UIActionBindingHandle.h | |
void SetDisplayName
(
const FText& DisplayName |
Should not be called often as broadcasts UCommonUIActionRouterBase::OnBoundActionsUpdated event | Input/UIActionBindingHandle.h | |
void Unregister() |
Input/UIActionBindingHandle.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FUIActionBindingHandle& Other |
Input/UIActionBindingHandle.h | ||
bool operator==
(
const FUIActionBindingHandle& Other |
Input/UIActionBindingHandle.h |