`unreal.Button`¶

class unreal.Button(outer: Optional[Object] = None, name: Union[Name, str] = 'None')¶

Bases: ContentWidget

The button is a click-able primitive widget to enable basic interaction, you can place any other widget inside a button to make a more complex and interesting click-able element in your UI.

Single Child
Clickable

C++ Source:

Module: UMG
File: Button.h

Editor Properties: (see get_editor_property/set_editor_property)

accessible_behavior (SlateAccessibleBehavior): [Read-Write] Accessible Behavior: Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.
accessible_summary_behavior (SlateAccessibleBehavior): [Read-Write] Accessible Summary Behavior: How to describe this widget when it’s being presented through a summary of a parent widget. If set to custom, additional customization options will appear.
accessible_summary_text (Text): [Read-Write] Accessible Summary Text: When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
accessible_text (Text): [Read-Write] Accessible Text: When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
background_color (LinearColor): [Read-Write] Background Color: The color multiplier for the button background
can_children_be_accessible (bool): [Read-Write] Can Children be Accessible: Whether or not children of this widget can appear as distinct accessible widgets.
click_method (ButtonClickMethod): [Read-Write] Click Method: The type of mouse action required by the user to trigger the buttons ‘Click’
clipping (WidgetClipping): [Read-Write] Clipping
color_and_opacity (LinearColor): [Read-Write] Color and Opacity: The color multiplier for the button content
cursor (MouseCursor): [Read-Write] Cursor
flow_direction_preference (FlowDirectionPreference): [Read-Write] Flow Direction Preference
is_enabled (bool): [Read-Write] Is Enabled
is_focusable (bool): [Read-Write] Is Focusable: Sometimes a button should only be mouse-clickable and never keyboard focusable.
is_volatile (bool): [Read-Write] Is Volatile: If true prevents the widget or its child’s geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
navigation (WidgetNavigation): [Read-Write] Navigation: The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.
on_clicked (OnButtonClickedEvent): [Read-Write] On Clicked: Called when the button is clicked
on_hovered (OnButtonHoverEvent): [Read-Write] On Hovered
on_pressed (OnButtonPressedEvent): [Read-Write] On Pressed: Called when the button is pressed
on_released (OnButtonReleasedEvent): [Read-Write] On Released: Called when the button is released
on_unhovered (OnButtonHoverEvent): [Read-Write] On Unhovered
override_accessible_defaults (bool): [Read-Write] Override Accessible Defaults: Override all of the default accessibility behavior and text for this widget.
override_cursor (bool): [Read-Write] Override Cursor
press_method (ButtonPressMethod): [Read-Write] Press Method: The type of keyboard/gamepad button press action required by the user to trigger the buttons ‘Click’
render_opacity (float): [Read-Write] Render Opacity
render_transform (WidgetTransform): [Read-Write] Render Transform
render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot
slot (PanelSlot): [Read-Write] Slot: The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.
tool_tip_text (Text): [Read-Write] Tool Tip Text
tool_tip_widget (Widget): [Read-Only] Tool Tip Widget
touch_method (ButtonTouchMethod): [Read-Write] Touch Method: The type of touch action required by the user to trigger the buttons ‘Click’
visibility (SlateVisibility): [Read-Write] Visibility
widget_style (ButtonStyle): [Read-Write] Widget Style: The button style used at runtime