`unreal.Button`¶

class unreal.Button(outer=None, name='None')¶

Bases: unreal.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] 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] 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] When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
accessible_text (Text): [Read-Write] When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
background_color (LinearColor): [Read-Write] The color multiplier for the button background
can_children_be_accessible (bool): [Read-Write] Whether or not children of this widget can appear as distinct accessible widgets.
click_method (ButtonClickMethod): [Read-Write] The type of mouse action required by the user to trigger the buttons ‘Click’
clipping (WidgetClipping): [Read-Write] Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.

NOTE: Elements in different clipping spaces can not be batched together, and so there is a performance cost to clipping. Do not enable clipping unless a panel actually needs to prevent content from showing up outside its bounds.
color_and_opacity (LinearColor): [Read-Write] The color multiplier for the button content
cursor (MouseCursor): [Read-Write] The cursor to show when the mouse is over the widget
flow_direction_preference (FlowDirectionPreference): [Read-Write] Allows you to set a new flow direction
is_enabled (bool): [Read-Write] Sets whether this widget can be modified interactively by the user
is_focusable (bool): [Read-Write] Sometimes a button should only be mouse-clickable and never keyboard focusable.
is_volatile (bool): [Read-Write] 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] 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] Called when the button is clicked
on_hovered (OnButtonHoverEvent): [Read-Write] On Hovered
on_pressed (OnButtonPressedEvent): [Read-Write] Called when the button is pressed
on_released (OnButtonReleasedEvent): [Read-Write] Called when the button is released
on_unhovered (OnButtonHoverEvent): [Read-Write] On Unhovered
override_accessible_defaults (bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.
override_cursor (bool): [Read-Write] Override Cursor
press_method (ButtonPressMethod): [Read-Write] The type of keyboard/gamepad button press action required by the user to trigger the buttons ‘Click’
render_opacity (float): [Read-Write] The opacity of the widget
render_transform (WidgetTransform): [Read-Write] The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.
render_transform_pivot (Vector2D): [Read-Write] The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
slot (PanelSlot): [Read-Write] The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.
tool_tip_text (Text): [Read-Write] Tooltip text to show when the user hovers over the widget with the mouse
tool_tip_widget (Widget): [Read-Only] Tooltip widget to show when the user hovers over the widget with the mouse
touch_method (ButtonTouchMethod): [Read-Write] The type of touch action required by the user to trigger the buttons ‘Click’
visibility (SlateVisibility): [Read-Write] The visibility of the widget
widget_style (ButtonStyle): [Read-Write] The button style used at runtime