1. Epic GamesDeveloper
  3. UCommonButtonBase

UCommonButtonBase

Button that disables itself when not active.

API > API/Plugins > API/Plugins/CommonUI

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Abstract, Blueprintable, ClassGroup&61;UI, Meta&61;&40;Category&61;"Common UI", DisableNativeTick&41;&41;  
class UCommonButtonBase : public UCommonUserWidget

Remarks

Button that disables itself when not active. Also updates actions for CommonActionWidget if bound to display platform-specific icons.

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly uint8: 1 bApplyAlphaOnDisable The type of mouse action required by the user to trigger the button's 'Click'
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly uint8: 1 bDisplayInputActionWhenNotInteractable True if the input action should be displayed when the button is not interactable
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly bool bHideInputAction Whether to hide the input action widget at all times (useful for textless small buttons)
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly uint8: 1 bHideInputActionWithKeyboard True if the input action should be hidden while the user is using a keyboard
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly uint8: 1 bInteractableWhenSelected If true, the button may be clicked while selected.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly uint8: 1 bLocked True if this button is currently locked.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly uint8: 1 bRequiresHold True if this button should have a press and hold behavior, triggering the click when the specified hold time is met
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly uint8: 1 bSelectable True if the button supports being in a "selected" state, which will update the style accordingly
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly uint8: 1 bShouldSelectUponReceivingFocus If true, the button will be selected when it receives focus.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly 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)
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly bool bSimulateHoverOnTouchInput True if this button should play the hover effect when pressed by a touch input
Public variable UProperty bool bStyleNoLongerNeedsConversion Used to track widgets that were created before changing the default style pointer to null
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly uint8: 1 bToggleable True if the button can be deselected by clicking it when selected
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly uint8: 1 bTriggerClickedAfterSelection  
Public variable UProperty Category BlueprintReadOnly fieldnotify FWidgetEventField ClickEvent  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TEnumAsByte< EButtonClickMethod::Type > ClickMethod The type of mouse action required by the user to trigger the button's 'Click'
Protected variable float CurrentHoldTime Current hold time for this button
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TSubclassOf< UCommonUIHoldData > HoldData Press and Hold values used for Keyboard and Mouse, Gamepad and Touch, depending on the current input type
Protected variable FTSTicker::FDelegateHandle HoldProgressRollbackTickerHandle Handle for ticker spawned for button hold rollback
Protected variable float HoldRollbackTime Time (in seconds) for hold progress to go from 1.0 (completed) to 0.0.
Protected variable FTSTicker::FDelegateHandle HoldTickerHandle Handle for ticker spawned for press and hold
Protected variable float HoldTime Press and hold time in seconds
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FSlateSound HoveredSlateSoundOverride Optional override for the sound to play when this button is hovered.
Protected variable UProperty Category, Meta BlueprintReadOnly TObjectPtr< UCommonActionWidget > 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
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly int32 InputPriority This is the priority for the TriggeringInputAction.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FSlateSound LockedHoveredSlateSoundOverride Optional override for the sound to play when this button is hovered while Locked
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FSlateSound LockedPressedSlateSoundOverride Optional override for the sound to play when this button is pressed while Locked
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly int32 MinHeight The minimum height of the button (only used if greater than the style's minimum)
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly int32 MinWidth The minimum width of the button (only used if greater than the style's minimum)
Protected variable UProperty Category, Meta BlueprintAssignable FCommonButtonBaseClicked OnButtonBaseClicked  
Protected variable UProperty Category, Meta BlueprintAssignable FCommonButtonBaseClicked OnButtonBaseDoubleClicked  
Protected variable UProperty Category, Meta BlueprintAssignable FCommonButtonBaseClicked OnButtonBaseHovered  
Protected variable UProperty Category, Meta BlueprintAssignable FCommonButtonBaseClicked OnButtonBaseUnhovered  
Protected variable UProperty Category, Meta BlueprintAssignable FCommonSelectedStateChangedBase OnSelectedChangedBase  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FSlateSound PressedSlateSoundOverride Optional override for the sound to play when this button is pressed.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TEnumAsByte< EButtonPressMethod::Type > PressMethod  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FSlateSound SelectedHoveredSlateSoundOverride Optional override for the sound to play when this button is hovered while Selected
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FSlateSound SelectedPressedSlateSoundOverride Optional override for the sound to play when this button is pressed while Selected
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TSubclassOf< UCommonButtonStyle > Style References the button style asset that defines a style in multiple sizes
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TEnumAsByte< EButtonTouchMethod::Type > TouchMethod  
Public variable FDataTableRowHandle TriggeredInputAction The input action that can be visualized as well as triggered when the user clicks the button.
Protected variable FUIActionBindingHandle TriggeringBindingHandle  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TObjectPtr< UInputAction > TriggeringEnhancedInputAction The enhanced input action that is bound to this button.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FDataTableRowHandle TriggeringInputAction The input action that is bound to this button.

Constructors

  Type Name Description
Public function  

UCommonButtonBase ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Virtual void Helper function to bind to input method change events
Protected function Virtual void Associates this button at its priority with the given key
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void

BP_OnLockedChanged ( bool bIsLocked
)

  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void  
Public function UFunction BlueprintCallable, Category void  
Protected function Virtual UCommonButtonInternalBase *  
Public function UFunction BlueprintCallable, Category void

DisableButtonWithReason ( const FText& DisabledReason
)

 Disables this button with a reason (use instead of SetIsEnabled)
Protected function Virtual void : DarenC - API decision, consider removing
Protected function Virtual Const bool

GetButtonAnalyticInfo ( FString& ButtonName,
FString& ABTestName,
FString& ExtraData
)

  
Protected function Virtual UFunction bool By default, if bRequiresHold is true, the bound Input Action will be forced to require hold as well.
Public function Const UFunction BlueprintCallable, Category void

GetCurrentButtonPadding ( FMargin& OutButtonPadding
)

  
Public function Const UFunction BlueprintCallable, Category void

GetCurrentCustomPadding ( FMargin& OutCustomPadding
)

  
Public function Const UFunction BlueprintCallable, Category UCommonTextStyle *  
Public function Const UFunction BlueprintCallable, Category TSubclassOf< UCommonTextStyle >  
Public function Const UFunction BlueprintCallable, Category UInputAction * Gets the appropriate enhanced input action that is set
Public function Const UFunction BlueprintCallable, Category bool

GetInputAction ( FDataTableRowHandle& InputActionRow
)

 Gets the appropriate input action that is set
Protected function Const ECommonInputMode  
Public function Const UFunction BlueprintCallable, Category bool Gets the bIsFocusable flag
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const UFunction BlueprintCallable, Category bool Get whether the button should become selected upon receiving focus or not
Public function Const UFunction BlueprintCallable, BlueprintPure, Category UMaterialInstanceDynamic * Returns the dynamic instance of the material being used for this button, if it is using a single material style.
Public function Const UFunction BlueprintCallable, Category UCommonButtonStyle * Current button style
Public function Const const UCommonButtonStyle *  
Protected function UFunction void Handler function registered to the underlying button's click.
Protected function FReply Handler function registered to the underlying button's double click.
Protected function UFunction void Helper function registered to the underlying button when pressed
Protected function UFunction void Helper function registered to the underlying button when released
Protected function Virtual UFunction void Helper function registered to the underlying button losing focus
Protected function Virtual UFunction void Helper function registered to the underlying button receiving focus
Protected function Virtual void  
Protected function Virtual UFunction void

HandleTriggeringActionCommited ( bool& bPassthrough
)

  
Protected function Virtual UFunction void  
Public function Const UFunction BlueprintCallable, Category bool Is this button currently interactable? (use instead of GetIsEnabled)
Protected function Const bool  
Public function Const UFunction BlueprintCallable, Category bool Is this button currently pressed?
Protected function Virtual UFunction void  
Protected function Virtual UFunction void

NativeOnActionProgress ( float HeldPercent
)

 Bound to the hold progress of the bound key from the input action
Protected function Virtual void  
Protected function Virtual void Allows derived classes to take action when the current text style has changed
Protected function Virtual void

NativeOnDeselected ( bool bBroadcast
)

  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual UFunction bool

NativeOnHoldProgress ( float DeltaTime
)

 Bound to the hold progress not related to the bound key
Protected function Virtual UFunction bool

NativeOnHoldProgressRollback ( float DeltaTime
)

 Bound to the hold progress rollback not related to the bound key
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void

NativeOnSelected ( bool bBroadcast
)

  
Protected function Virtual void  
Protected function UFunction Category, BlueprintImplementableEvent void Callback fired when hold events complete
Protected function UFunction Category, BlueprintImplementableEvent void

OnActionProgress ( float HeldPercent
)

 Callback fired continously during hold interactions
Public function Const FCommonButtonEvent &  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void Allows derived classes to take action when the current text style has changed
Public function Const FCommonButtonEvent &  
Public function Const FCommonButtonEvent &  
Public function Const FCommonButtonEvent &  
Public function Const FCommonButtonEvent &  
Protected function Virtual UFunction void

OnInputMethodChanged ( ECommonInputType CurrentInputType
)

 Called via delegate when the input method changes
Public function Const FOnIsSelectedChanged &  
Public function Const FCommonButtonEvent &  
Public function Const FCommonButtonEvent &  
Public function Const FCommonButtonEvent &  
Public function Const FCommonButtonEvent &  
Protected function UFunction Category, BlueprintImplementableEvent void

OnTriggeredInputActionChanged ( const FDataTableRowHandle& NewTriggeredAction
)

 Callback fired when input action datatable row changes
Protected function UFunction Category, BlueprintImplementableEvent void Callback fired when enhanced input action changes
Protected function UFunction Category, BlueprintImplementableEvent void

OnTriggeringInputActionChanged ( const FDataTableRowHandle& NewTriggeredAction
)

 Callback fired when triggered input action datatable row changes
Public function Const FCommonButtonEvent &  
Protected function void  
Public function UFunction BlueprintCallable, Category void Set the click method for mouse interaction
Public function UFunction BlueprintCallable, Category void

SetHideInputAction ( bool bInHideInputAction
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetInputActionProgressMaterial ( const FSlateBrush& InProgressMaterialBrush,
const FName& InProgressMaterialParam
)

  
Public function UFunction BlueprintCallable, Category void

SetIsFocusable ( bool bInIsFocusable
)

 Updates the bIsFocusable flag
Public function UFunction BlueprintCallable, Category void

SetIsInteractableWhenSelected ( bool bInInteractableWhenSelected
)

 Change whether this widget is selectable at all. If false and currently selected, will deselect.
Public function UFunction BlueprintCallable, Category void

SetIsInteractionEnabled ( bool bInIsInteractionEnabled
)

 Change whether this widget is selectable at all. If false and currently selected, will deselect.
Public function UFunction BlueprintCallable, Category void

SetIsLocked ( bool bInIsLocked
)

 Change whether this widget is locked.
Public function UFunction BlueprintCallable, Category void

SetIsSelectable ( bool bInIsSelectable
)

 Change whether this widget is selectable at all. If false and currently selected, will deselect.
Public function UFunction BlueprintCallable, Category void

SetIsSelected ( bool InSelected,
bool bGiveClickFeedback
)

 Change the selected state manually.
Public function UFunction BlueprintCallable, Category void

SetIsToggleable ( bool bInIsToggleable
)

 Change whether this widget is toggleable. If toggleable, clicking when selected will deselect.
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetMinDimensions ( int32 InMinWidth,
int32 InMinHeight
)

 Sets the minimum dimensions of this button
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void Set the click method for keyboard/gamepad button press interaction
Public function UFunction BlueprintCallable, Category void  
Protected function UFunction BlueprintCallable, Category, Meta void

SetSelectedInternal ( bool bInSelected,
bool bAllowSound,
bool bBroadcast
)

 Internal method to allow the selected state to be set regardless of selectability or toggleability
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetShouldSelectUponReceivingFocus ( bool bInShouldSelectUponReceivingFocus
)

 Set whether the button should become selected upon receiving focus or not; Only settable for buttons that are selectable
Public function UFunction BlueprintCallable, Category void

SetShouldUseFallbackDefaultInputAction ( bool bInShouldUseFallbackDefaultInputAction
)

 Change whether this widget should use the fallback default input action.
Public function UFunction BlueprintCallable, Category void Sets the style of this button, rebuilds the internal styling
Public function UFunction BlueprintCallable, Category void Set the click method for touch interaction
Public function UFunction BlueprintCallable, Category void

SetTriggeredInputAction ( const FDataTableRowHandle& InputActionRow
)

 Updates the current triggered action
Public function UFunction BlueprintCallable, Category void Updates the current triggering enhanced input action, requires enhanced input enabled in CommonUI settings
Public function UFunction BlueprintCallable, Category void

SetTriggeringInputAction ( const FDataTableRowHandle& InputActionRow
)

 Updates the current triggering action
Protected function UFunction BlueprintCallable, Category void Unless this is called, we will assume the double click should be converted into a normal click.
Protected function Virtual void Helper function to unbind from input method change events
Protected function Virtual void Associates this button at its priority with the given key
Protected function Virtual UFunction void

UpdateHoldData ( ECommonInputType CurrentInputType
)

 If HoldData is valid, assigns its values to Keyboard and Mouse, Gamepad and Touch, based off the Current Input Type.
Protected function Virtual void Helper function to update the associated input action widget, if any, based upon the state of the button
Protected function void  

Overridden from UUserWidget

  Type Name Description
Public function Virtual bool  
Public function Virtual void  
Public function Virtual void  
Public function Virtual Const bool  
Protected function Virtual void

NativeOnFocusLost ( const FFocusEvent& InFocusEvent
)

  
Protected function Virtual FReply

NativeOnFocusReceived ( const FGeometry& InGeometry,
const FFocusEvent& InFocusEvent
)

  
Protected function Virtual void

NativeOnMouseEnter ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

  
Protected function Virtual void

NativeOnMouseLeave ( const FPointerEvent& InMouseEvent
)

  

Overridden from UWidget

  Type Name Description
Protected function Virtual const FText Gets the palette category of the widget
Public function Virtual Const bool Returns true if the widget is currently being hovered by a pointer device
Protected function Virtual void Called after constructing a new widget from the palette.
Protected function Virtual void Function called after the underlying SWidget is constructed.
Public function Virtual void

SetIsEnabled ( bool bInIsEnabled
)

 Sets the current enabled status of the widget
Protected function Virtual void Applies all properties to the native widget if possible.

Overridden from UObject

  Type Name Description
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.

Classes

  Type Name Description
Public class FCommonButtonEvent    
Public class FOnIsSelectedChanged    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page