unreal.CommonActionWidget

class unreal.CommonActionWidget(outer: Object | None = None, name: Name | str = 'None')

Bases: Widget

A widget that shows a platform-specific icon for the given input action.

C++ Source:

  • Plugin: CommonUI

  • Module: CommonUI

  • File: CommonActionWidget.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.

  • can_children_be_accessible (bool): [Read-Write] Whether or not children of this widget can appear as distinct accessible widgets.

  • 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.

  • cursor (MouseCursor): [Read-Write] The cursor to show when the mouse is over the widget

  • design_time_key (Key): [Read-Write]

  • enhanced_input_action (InputAction): [Read-Write] Input Action this common action widget is intended to represent. Optional if using EnhancedInputs

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Allows you to set a new flow direction

  • icon_rim_brush (SlateBrush): [Read-Write]

  • input_actions (Array[DataTableRowHandle]): [Read-Write] List all the input actions that this common action widget is intended to represent. In some cases you might have multiple actions that you need to represent as a single entry in the UI. For example - zoom, might be mouse wheel up or down, but you just need to show a single icon for Up & Down on the mouse, this solves that problem.

  • is_enabled (bool): [Read-Write] Sets whether this widget can be modified interactively by the user

  • 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_input_method_changed (OnInputMethodChanged): [Read-Write]

  • override_accessible_defaults (bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.

  • override_cursor (bool): [Read-Write]

  • pixel_snapping (WidgetPixelSnapping): [Read-Write] If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation

  • progress_material_brush (SlateBrush): [Read-Write] The material to use when showing held progress, the progress will be sent using the material parameter defined by ProgressMaterialParam and the value will range from 0..1.

  • progress_material_param (Name): [Read-Write] The material parameter on ProgressMaterialBrush to update the held percentage. This value will be 0..1.

  • 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

  • visibility (SlateVisibility): [Read-Write] The visibility of the widget

property enhanced_input_action: InputAction

[Read-Only] Input Action this common action widget is intended to represent. Optional if using EnhancedInputs

Type:

(InputAction)

get_display_text() → Text

Get Display Text

Return type:

Text

get_icon() → SlateBrush

End UWidet

Return type:

SlateBrush

property icon_rim_brush: SlateBrush

[Read-Only]

Type:

(SlateBrush)

property input_actions: None

[Read-Only] List all the input actions that this common action widget is intended to represent. In some cases you might have multiple actions that you need to represent as a single entry in the UI. For example - zoom, might be mouse wheel up or down, but you just need to show a single icon for Up & Down on the mouse, this solves that problem.

Type:

(Array[DataTableRowHandle])

is_held_action() → bool

Is Held Action

Return type:

bool

property on_input_method_changed: OnInputMethodChanged

[Read-Write]

Type:

(OnInputMethodChanged)

property progress_material_brush: SlateBrush

[Read-Write] The material to use when showing held progress, the progress will be sent using the material parameter defined by ProgressMaterialParam and the value will range from 0..1.

Type:

(SlateBrush)

property progress_material_param: Name

[Read-Only] The material parameter on ProgressMaterialBrush to update the held percentage. This value will be 0..1.

Type:

(Name)

set_enhanced_input_action(input_action) → None

Set Enhanced Input Action

Parameters:

input_action (InputAction) –

set_icon_rim_brush(icon_rim_brush) → None

Set Icon Rim Brush

Parameters:

icon_rim_brush (SlateBrush) –

set_input_action(input_action_row) → None

Set Input Action

Parameters:

input_action_row (DataTableRowHandle) –

set_input_actions(new_input_actions) → None

Set Input Actions

Parameters:

new_input_actions (Array[DataTableRowHandle]) –