1. Epic GamesDeveloper
  3. USlider

USlider

A simple widget that shows a sliding bar with a handle that allows you to control the value in a user define range (between 0..1 by default).

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/Slider.h
Include #include "Components/Slider.h"

Syntax

UCLASS (MinimalAPI)  
class USlider : public UWidget

Remarks

A simple widget that shows a sliding bar with a handle that allows you to control the value in a user define range (between 0..1 by default).

  • No Children

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite blueprintsetter, getter, setter bool IndentHandle Whether the slidable area should be indented to fit the handle.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool IsFocusable Should the slider be focusable?
Protected variable float K2_Cache_Value  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite blueprintsetter, getter, setter bool Locked Whether the handle is interactive or fixed.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter float MaxValue The maximum value the slider can be set to.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter float MinValue The minimum value the slider can be set to.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly bool MouseUsesStep Sets new value if mouse position is greater/less than half the step size.
Protected variable TSharedPtr< SSlider > MySlider Native Slate Widget
Public variable UProperty Category BlueprintAssignable FOnControllerCaptureBeginEvent OnControllerCaptureBegin Invoked when the controller capture begins.
Public variable UProperty Category BlueprintAssignable FOnControllerCaptureEndEvent OnControllerCaptureEnd Invoked when the controller capture ends.
Public variable UProperty Category BlueprintAssignable FOnMouseCaptureBeginEvent OnMouseCaptureBegin Invoked when the mouse is pressed and a capture begins.
Public variable UProperty Category BlueprintAssignable FOnMouseCaptureEndEvent OnMouseCaptureEnd Invoked when the mouse is released and a capture ends.
Public variable UProperty Category BlueprintAssignable FOnFloatValueChangedEvent OnValueChanged Called when the value is changed by slider or typing.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter TEnumAsByte< EOrientation > Orientation The slider's orientation.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly bool RequiresControllerLock Sets whether we have to lock input to change the slider value.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FLinearColor SliderBarColor The color to draw the slider bar in.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FLinearColor SliderHandleColor The color to draw the slider handle in.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter float StepSize The amount to adjust the value by, when using a controller or keyboard
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintgetter, blueprintsetter, fieldnotify, getter, setter float Value The volume value to display.
Public variable UProperty FGetFloat ValueDelegate A bindable delegate to allow logic to drive the value of the widget
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FSliderStyle WidgetStyle The progress bar style

Constructors

  Type Name Description
Public function  

USlider ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const float Gets the maximum value of the slider.
Public function Const float Gets the minimum value of the slider.
Public function Const UFunction BlueprintCallable, Category float Get the current value scaled from 0 to 1
Public function Const EOrientation Getg the slider's orientation.
Public function Const FLinearColor Gets the color of the slider bar.
Public function Const FLinearColor Gets the color of the handle bar
Public function Const float Gets the amount to adjust the value by.
Public function Const UFunction BlueprintCallable, Category float Gets the current value of the slider.
Public function Const const FSliderStyle & Get the style used by the widget.
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void

HandleOnValueChanged ( float InValue
)

  
Public function Const bool Gets if the slidable area should be indented to fit the handle.
Public function Const bool Returns true when the handle is fixed.
Protected function float  
Public function UFunction BlueprintCallable, Category void

SetIndentHandle ( bool InValue
)

 Sets if the slidable area should be indented to fit the handle.
Public function UFunction BlueprintCallable, Category void

SetLocked ( bool InValue
)

 Sets the handle to be interactive or fixed.
Public function UFunction BlueprintCallable, Category void

SetMaxValue ( float InValue
)

 Sets the maximum value of the slider.
Public function UFunction BlueprintCallable, Category void

SetMinValue ( float InValue
)

 Sets the minimum value of the slider.
Public function void

SetOrientation ( EOrientation InOrientation
)

 Sets the slider's orientation.
Public function UFunction BlueprintCallable, Category void

SetSliderBarColor ( FLinearColor InValue
)

 Sets the color of the slider bar.
Public function UFunction BlueprintCallable, Category void

SetSliderHandleColor ( FLinearColor InValue
)

 Sets the color of the handle bar
Public function UFunction BlueprintCallable, Category void

SetStepSize ( float InValue
)

 Sets the amount to adjust the value by, when using a controller or keyboard.
Public function UFunction BlueprintCallable, Category void

SetValue ( float InValue
)

 Sets the current value of the slider.
Public function void

SetWidgetStyle ( const FSliderStyle& InStyle
)

 Set the style used by the widget.

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page