unreal.ProgressBar

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

Bases: Widget

The progress bar widget is a simple bar that fills up that can be restyled to fit any number of uses.

  • No Children

C++ Source:

  • Module: UMG

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

  • bar_fill_style (ProgressBarFillStyle): [Read-Write] Bar Fill Style

  • bar_fill_type (ProgressBarFillType): [Read-Write] Bar Fill Type

  • border_padding (Vector2D): [Read-Write] Border Padding

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

  • clipping (WidgetClipping): [Read-Write] Clipping

  • cursor (MouseCursor): [Read-Write] Cursor

  • fill_color_and_opacity (LinearColor): [Read-Write] Fill Color and Opacity

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Flow Direction Preference

  • is_enabled (bool): [Read-Write] Is Enabled

  • is_marquee (bool): [Read-Write] Is Marquee

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

  • 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

  • percent (float): [Read-Write] Percent

  • 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

  • visibility (SlateVisibility): [Read-Write] Visibility

  • widget_style (ProgressBarStyle): [Read-Write] Widget Style

property bar_fill_style: ProgressBarFillStyle

[Read-Write] Bar Fill Style

Type:

(ProgressBarFillStyle)

property bar_fill_type: ProgressBarFillType

[Read-Write] Bar Fill Type

Type:

(ProgressBarFillType)

property border_padding: Vector2D

[Read-Write] Border Padding

Type:

(Vector2D)

property fill_color_and_opacity: LinearColor

[Read-Write] Fill Color and Opacity

Type:

(LinearColor)

property is_marquee: bool

[Read-Write] Is Marquee

Type:

(bool)

property percent: float

[Read-Write] Percent

Type:

(float)

set_fill_color_and_opacity(color) → None

Sets the fill color of the progress bar.

Parameters:

color (LinearColor) –

set_is_marquee(inb_is_marquee) → None

Sets the progress bar to show as a marquee.

Parameters:

inb_is_marquee (bool) –

set_percent(percent) → None

Sets the current value of the ProgressBar.

Parameters:

percent (float) –

property widget_style: ProgressBarStyle

[Read-Write] Widget Style

Type:

(ProgressBarStyle)