unreal.CommonActivatableWidgetContainerBase

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

Bases: Widget

Base of widgets built to manage N activatable widgets, displaying one at a time. Intentionally meant to be black boxes that do not expose child/slot modification like a normal panel widget.

C++ Source:

  • Plugin: CommonUI

  • Module: CommonUI

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

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

  • 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

  • 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

  • transition_curve_type (TransitionCurve): [Read-Write] The curve function type to apply to the transition animation

  • transition_duration (float): [Read-Write] The total duration of a single transition between widgets

  • transition_fallback_strategy (CommonSwitcherTransitionFallbackStrategy): [Read-Write] Controls how we will choose another widget if a transitioning widget is removed during the transition. Note for Queues and Stacks, ECommonSwitcherTransitionFallbackStrategy::Previous is a good option.

  • transition_type (CommonSwitcherTransition): [Read-Write] The type of transition to play between widgets

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

bp_add_widget(activatable_widget_class) → CommonActivatableWidget

Adds a widget of the given class to the container. Note that all widgets added to the container are pooled, so the caller should not try to cache and re-use the created widget.

It is possible for multiple instances of the same class to be added to the container at once, so any instance created in the past is not guaranteed to be the one returned this time.

So in practice, you should not trust that any prior state has been retained on the returned widget, and establish all appropriate properties every time.

Parameters:

activatable_widget_class (type(Class)) –

Return type:

CommonActivatableWidget

clear_widgets() → None

Clear Widgets

get_active_widget() → CommonActivatableWidget

Get Active Widget

Return type:

CommonActivatableWidget

get_transition_duration() → float

Get Transition Duration

Return type:

float

remove_widget(widget_to_remove) → None

Remove Widget

Parameters:

widget_to_remove (CommonActivatableWidget) –

set_transition_duration(duration) → None

Set Transition Duration

Parameters:

duration (float) –

property transition_fallback_strategy: CommonSwitcherTransitionFallbackStrategy

[Read-Only] Controls how we will choose another widget if a transitioning widget is removed during the transition. Note for Queues and Stacks, ECommonSwitcherTransitionFallbackStrategy::Previous is a good option.

Type:

(CommonSwitcherTransitionFallbackStrategy)