`unreal.Synth2DSlider`¶

class unreal.Synth2DSlider(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:

Plugin: Synthesis
Module: Synthesis
File: Synth2DSlider.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: Whether the slidable area should be indented to fit the 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: Whether the handle is interactive or fixed.
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 (OnControllerCaptureBeginEventSynth2D): [Read-Write] On Controller Capture Begin: Invoked when the controller capture begins.
on_controller_capture_end (OnControllerCaptureEndEventSynth2D): [Read-Write] On Controller Capture End: Invoked when the controller capture ends.
on_mouse_capture_begin (OnMouseCaptureBeginEventSynth2D): [Read-Write] On Mouse Capture Begin: Invoked when the mouse is pressed and a capture begins.
on_mouse_capture_end (OnMouseCaptureEndEventSynth2D): [Read-Write] On Mouse Capture End: Invoked when the mouse is released and a capture ends.
on_value_changed_x (OnFloatValueChangedEventSynth2D): [Read-Write] On Value Changed X: Called when the value is changed by slider or typing.
on_value_changed_y (OnFloatValueChangedEventSynth2D): [Read-Write] On Value Changed Y: Called when the value is changed by slider or typing.
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
slider_handle_color (LinearColor): [Read-Write] Slider Handle Color: The color to draw the slider handle in.
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: The amount to adjust the value by, when using a controller or keyboard
tool_tip_text (Text): [Read-Write] Tool Tip Text
tool_tip_widget (Widget): [Read-Only] Tool Tip Widget
value_x (float): [Read-Write] Value X
value_y (float): [Read-Write] Value Y
visibility (SlateVisibility): [Read-Write] Visibility
widget_style (Synth2DSliderStyle): [Read-Write] Widget Style: The progress bar style