UButton

class UMG Blueprint Since 4.5

Inherits: UObjectBase › UObjectBaseUtility › UObject › UVisual › UWidget › UPanelWidget › UContentWidget › UButton

#include "Components/Button.h"

Description

A clickable container widget that holds a single child widget. Exposes OnClicked, OnPressed, OnReleased, and OnHovered delegates for user interaction.

Caveats & Gotchas

• UButton is a ContentWidget — it holds exactly one child. Place other widgets (e.g. UTextBlock, UImage) inside it to create styled buttons.
• Direct property access for WidgetStyle, ColorAndOpacity, and BackgroundColor was deprecated in UE 5.2. Use the getter/setter functions.
• Keyboard/gamepad focus navigation is enabled by default (IsFocusable). Set to false for mouse-only buttons in menus that don't need controller support.

Signature

class UButton : public UContentWidget

Example

Bind a click event in C++ C++

// In NativeConstruct:
MyButton->OnClicked.AddDynamic(this, &UMyWidget::OnMyButtonClicked);

// Handler:
void UMyWidget::OnMyButtonClicked()
{
    // handle click
}

Functions (15)

Appearance 6 Interaction 9

Appearance

6 ▼

Access	Type	Name	Description
public	function	UButton::GetBackgroundColor	Returns the color multiplier currently applied to the button's background brush.
public	function	UButton::GetColorAndOpacity	Returns the color multiplier currently applied to the button's content (the widget placed inside it), including its alpha.
public	function	UButton::SetBackgroundColor	Sets the color and opacity multiplier applied to the button's background brush across all its visual states.
public	function	UButton::SetColorAndOpacity	Sets the color and opacity multiplier applied to the button's child content, not its background.
public	function	UButton::GetStyle	Returns the button's current visual style, including the brushes used for its normal, hovered, pressed, and disabled states.
public	function	UButton::SetStyle	Replaces the button's entire visual style, including its per-state brushes and click/hover sounds.

Interaction

9 ▼

Access	Type	Name	Description
public	function	UButton::GetIsFocusable	Returns whether the button can receive keyboard/gamepad focus, or is restricted to mouse-click only interaction.
public	function	UButton::IsPressed	Returns true while the user is actively holding the button down.
public	function	UButton::GetClickMethod	Returns the mouse action currently required to trigger the button's click — down, up, or precise-click.
public	function	UButton::GetPressMethod	Returns the keyboard or gamepad button-press action currently required to trigger the button's click.
public	function	UButton::GetTouchMethod	Returns the touch action currently required to trigger the button's click on touch input devices.
public	function	UButton::SetAllowDragDrop	Enables or disables drag-and-drop detection on the button so it can respond to OnButtonDragDetected and related drag events.
public	function	UButton::SetClickMethod	Sets which mouse interaction pattern triggers the button's OnClicked event.
public	function	UButton::SetPressMethod	Sets which keyboard or gamepad interaction pattern triggers the button's OnClicked event when it has focus.
public	function	UButton::SetTouchMethod	Sets which touch interaction pattern triggers the button's OnClicked event on touch-input platforms.

Properties

Access	Type	Name	Description
public	property	UButton::OnClicked	Multicast event broadcast when the user completes a click on the button, per the button's configured ClickMethod.
public	property	UButton::OnHovered	Multicast event broadcast when the pointer begins hovering over the button.
public	property	UButton::OnPressed	Multicast event broadcast the moment the button is pressed down, before it's released.
public	property	UButton::OnReleased	Multicast event broadcast when the button is released after having been pressed.
public	property	UButton::OnUnhovered	Multicast delegate broadcast when the pointer stops hovering over the button after having hovered it.

Version History

Introduced in: 4.5

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?