/Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonButtonBase.h
Button that disables itself when not active. Also updates actions for CommonActionWidget if bound to display platform-specific icons.
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Blueprintable, ClassGroup=UI, Meta=(Category="Common UI", DisableNativeTick)) class UCommonButtonBase : public [UCommonUserWidget](API\Plugins\CommonUI\UCommonUserWidget)
uint8: 1
bApplyAlphaOnDisable
The type of mouse action required by the user to trigger the button's 'Click'
uint8: 1
bDisplayInputActionWhenNotInteractable
True if the input action should be displayed when the button is not interactable
bool
bHideInputAction
Whether to hide the input action widget at all times (useful for textless small buttons)
uint8: 1
bHideInputActionWithKeyboard
True if the input action should be hidden while the user is using a keyboard
uint8: 1
bInteractableWhenSelected
If true, the button may be clicked while selected.
uint8: 1
bLocked
True if this button is currently locked.
uint8: 1
bRequiresHold
True if this button should have a press and hold behavior, triggering the click when the specified hold time is met
uint8: 1
bSelectable
True if the button supports being in a "selected" state, which will update the style accordingly
uint8: 1
bShouldSelectUponReceivingFocus
If true, the button will be selected when it receives focus.
uint8: 1
bShouldUseFallbackDefaultInputAction
True if this button should use the default fallback input action (bool is useful for buttons that shouldn't because they are never directly hit via controller)
bool
bSimulateHoverOnTouchInput
True if this button should play the hover effect when pressed by a touch input
bool
bStyleNoLongerNeedsConversion
Used to track widgets that were created before changing the default style pointer to null
uint8: 1
bToggleable
True if the button can be deselected by clicking it when selected
uint8: 1
bTriggerClickedAfterSelection
FWidgetEventFie...
ClickEvent
TEnumAsByte<EB...
ClickMethod
The type of mouse action required by the user to trigger the button's 'Click'
float
CurrentHoldTime
Current hold time for this button
TSubclassOf<UC...
HoldData
Press and Hold values used for Keyboard and Mouse, Gamepad and Touch, depending on the current input type
FTSTicker::FDel...
HoldProgressRollbackTickerHandle
Handle for ticker spawned for button hold rollback
float
HoldRollbackTime
Time (in seconds) for hold progress to go from 1.0 (completed) to 0.0.
FTSTicker::FDel...
HoldTickerHandle
Handle for ticker spawned for press and hold
float
HoldTime
Press and hold time in seconds
FSlateSound
HoveredSlateSoundOverride
Optional override for the sound to play when this button is hovered.
TObjectPtr<UCo...
InputActionWidget
Optionally bound widget for visualization behavior of an input action; NOTE: If specified, will visualize according to the following algorithm: If TriggeringEnhancedInputAction is specified, visualize it else: If TriggeringInputAction is specified, visualize it else: If TriggeredInputAction is specified, visualize it else: Visualize the default click action while hovered
int32
InputPriority
This is the priority for the TriggeringInputAction.
FSlateSound
LockedHoveredSlateSoundOverride
Optional override for the sound to play when this button is hovered while Locked
FSlateSound
LockedPressedSlateSoundOverride
Optional override for the sound to play when this button is pressed while Locked
int32
MinHeight
The minimum height of the button (only used if greater than the style's minimum)
int32
MinWidth
The minimum width of the button (only used if greater than the style's minimum)
FCommonButtonBa...
OnButtonBaseClicked
FCommonButtonBa...
OnButtonBaseDoubleClicked
FCommonButtonBa...
OnButtonBaseHovered
FCommonButtonBa...
OnButtonBaseUnhovered
FCommonSelected...
OnSelectedChangedBase
FSlateSound
PressedSlateSoundOverride
Optional override for the sound to play when this button is pressed.
TEnumAsByte<EB...
PressMethod
FSlateSound
SelectedHoveredSlateSoundOverride
Optional override for the sound to play when this button is hovered while Selected
FSlateSound
SelectedPressedSlateSoundOverride
Optional override for the sound to play when this button is pressed while Selected
TSubclassOf<UC...
Style
References the button style asset that defines a style in multiple sizes
TEnumAsByte<EB...
TouchMethod
FDataTableRowHa...
TriggeredInputAction
The input action that can be visualized as well as triggered when the user clicks the button.
FUIActionBindin...
TriggeringBindingHandle
TObjectPtr<UIn...
TriggeringEnhancedInputAction
The enhanced input action that is bound to this button.
FDataTableRowHa...
TriggeringInputAction
The input action that is bound to this button.