Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

USlider

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

USlider

References

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

Syntax

class USlider : public UWidget

Remarks

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

Variables

	Name	Description
bool	IndentHandle	Whether the slidable area should be indented to fit the handle.
bool	IsFocusable	Should the slider be focusable?
float	K2_Cache_Value
bool	Locked	Whether the handle is interactive or fixed.
float	MaxValue	The maximum value the slider can be set to.
float	MinValue	The minimum value the slider can be set to.
bool	MouseUsesStep	Sets new value if mouse position is greater/less than half the step size.
TSharedPtr< SSl...	MySlider	Native Slate Widget
FOnControllerCa...	OnControllerCaptureBegin	Invoked when the controller capture begins.
FOnControllerCa...	OnControllerCaptureEnd	Invoked when the controller capture ends.
FOnMouseCapture...	OnMouseCaptureBegin	Invoked when the mouse is pressed and a capture begins.
FOnMouseCapture...	OnMouseCaptureEnd	Invoked when the mouse is released and a capture ends.
FOnFloatValueCh...	OnValueChanged	Called when the value is changed by slider or typing.
TEnumAsByte< EO...	Orientation	The slider's orientation.
bool	RequiresControllerLock	Sets whether we have to lock input to change the slider value.
FLinearColor	SliderBarColor	The color to draw the slider bar in.
FLinearColor	SliderHandleColor	The color to draw the slider handle in.
float	StepSize	The amount to adjust the value by, when using a controller or keyboard
float	Value	The volume value to display.
FGetFloat	ValueDelegate	A bindable delegate to allow logic to drive the value of the widget
FSliderStyle	WidgetStyle	The progress bar style

Constructors

	Name	Description
	USlider ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
float	GetNormalizedValue()	Get the current value scaled from 0 to 1
float	GetValue()	Gets the current value of the slider.
void	HandleOnControllerCaptureBegin()
void	HandleOnControllerCaptureEnd()
void	HandleOnMouseCaptureBegin()
void	HandleOnMouseCaptureEnd()
void	HandleOnValueChanged ( float InValue )
float	K2_Gate_Value()
void	SetIndentHandle ( bool InValue )	Sets if the slidable area should be indented to fit the handle
void	SetLocked ( bool InValue )	Sets the handle to be interactive or fixed
void	SetMaxValue ( float InValue )	Sets the maximum value of the slider.
void	SetMinValue ( float InValue )	Sets the minimum value of the slider.
void	SetSliderBarColor ( FLinearColor InValue )	Sets the color of the slider bar
void	SetSliderHandleColor ( FLinearColor InValue )	Sets the color of the handle bar
void	SetStepSize ( float InValue )	Sets the amount to adjust the value by, when using a controller or keyboard
void	SetValue ( float InValue )	Sets the current value of the slider.

Overridden from UWidget

	Name	Description
TSharedPtr< ...	GetAccessibleWidget()	Gets the widget that accessibility properties should synchronize to.
const FText	GetPaletteCategory()	Gets the palette category of the widget
TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss