unreal.Slider

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

Bases: Widget

A simple widget that shows a sliding bar with a handle that allows you to control the value between 0..1.

  • No Children

C++ Source:

  • Module: UMG

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

  • 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

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

  • indent_handle (bool): [Read-Write] Indent Handle

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

  • is_focusable (bool): [Read-Write] Is Focusable: Should the slider be 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.

  • locked (bool): [Read-Write] Locked

  • max_value (float): [Read-Write] Max Value

  • min_value (float): [Read-Write] Min Value

  • mouse_uses_step (bool): [Read-Write] Mouse Uses Step: Sets new value if mouse position is greater/less than half the step size.

  • 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_controller_capture_begin (OnControllerCaptureBeginEvent): [Read-Write] On Controller Capture Begin: Invoked when the controller capture begins.

  • on_controller_capture_end (OnControllerCaptureEndEvent): [Read-Write] On Controller Capture End: Invoked when the controller capture ends.

  • on_mouse_capture_begin (OnMouseCaptureBeginEvent): [Read-Write] On Mouse Capture Begin: Invoked when the mouse is pressed and a capture begins.

  • on_mouse_capture_end (OnMouseCaptureEndEvent): [Read-Write] On Mouse Capture End: Invoked when the mouse is released and a capture ends.

  • on_value_changed (OnFloatValueChangedEvent): [Read-Write] On Value Changed: Called when the value is changed by slider or typing.

  • orientation (Orientation): [Read-Write] Orientation

  • 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

  • render_opacity (float): [Read-Write] Render Opacity

  • render_transform (WidgetTransform): [Read-Write] Render Transform

  • render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot

  • requires_controller_lock (bool): [Read-Write] Requires Controller Lock: Sets whether we have to lock input to change the slider value.

  • slider_bar_color (LinearColor): [Read-Write] Slider Bar Color

  • slider_handle_color (LinearColor): [Read-Write] Slider Handle Color

  • slot (PanelSlot): [Read-Write] Slot: The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

  • step_size (float): [Read-Write] Step Size

  • tool_tip_text (Text): [Read-Write] Tool Tip Text

  • tool_tip_widget (Widget): [Read-Only] Tool Tip Widget

  • value (float): [Read-Write] Value

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

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

get_normalized_value() → float

Get the current value scaled from 0 to 1

Return type:

float

get_value() → float

Gets the current value of the slider.

Return type:

float

property indent_handle: bool

[Read-Write] Indent Handle

Type:

(bool)

property is_focusable: bool

[Read-Only] Is Focusable: Should the slider be focusable?

Type:

(bool)

property locked: bool

[Read-Write] Locked

Type:

(bool)

property max_value: float

[Read-Write] Max Value

Type:

(float)

property min_value: float

[Read-Write] Min Value

Type:

(float)

property mouse_uses_step: bool

[Read-Only] Mouse Uses Step: Sets new value if mouse position is greater/less than half the step size.

Type:

(bool)

property on_controller_capture_begin: OnControllerCaptureBeginEvent

[Read-Write] On Controller Capture Begin: Invoked when the controller capture begins.

Type:

(OnControllerCaptureBeginEvent)

property on_controller_capture_end: OnControllerCaptureEndEvent

[Read-Write] On Controller Capture End: Invoked when the controller capture ends.

Type:

(OnControllerCaptureEndEvent)

property on_mouse_capture_begin: OnMouseCaptureBeginEvent

[Read-Write] On Mouse Capture Begin: Invoked when the mouse is pressed and a capture begins.

Type:

(OnMouseCaptureBeginEvent)

property on_mouse_capture_end: OnMouseCaptureEndEvent

[Read-Write] On Mouse Capture End: Invoked when the mouse is released and a capture ends.

Type:

(OnMouseCaptureEndEvent)

property on_value_changed: OnFloatValueChangedEvent

[Read-Write] On Value Changed: Called when the value is changed by slider or typing.

Type:

(OnFloatValueChangedEvent)

property orientation: Orientation

[Read-Write] Orientation

Type:

(Orientation)

property requires_controller_lock: bool

[Read-Only] Requires Controller Lock: Sets whether we have to lock input to change the slider value.

Type:

(bool)

set_indent_handle(value) → None

Sets if the slidable area should be indented to fit the handle.

Parameters:

value (bool) –

set_locked(value) → None

Sets the handle to be interactive or fixed.

Parameters:

value (bool) –

set_max_value(value) → None

Sets the maximum value of the slider.

Parameters:

value (float) –

set_min_value(value) → None

Sets the minimum value of the slider.

Parameters:

value (float) –

set_slider_bar_color(value) → None

Sets the color of the slider bar.

Parameters:

value (LinearColor) –

set_slider_handle_color(value) → None

Sets the color of the handle bar

Parameters:

value (LinearColor) –

set_step_size(value) → None

Sets the amount to adjust the value by, when using a controller or keyboard.

Parameters:

value (float) –

set_value(value) → None

Sets the current value of the slider.

Parameters:

value (float) –

property slider_bar_color: LinearColor

[Read-Write] Slider Bar Color

Type:

(LinearColor)

property slider_handle_color: LinearColor

[Read-Write] Slider Handle Color

Type:

(LinearColor)

property step_size: float

[Read-Write] Step Size

Type:

(float)

property value: float

[Read-Write] Value

Type:

(float)

property widget_style: SliderStyle

[Read-Write] Widget Style

Type:

(SliderStyle)