Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Slider

Inherits: Range < Control < CanvasItem < Node < Object

Inherited By: HSlider, VSlider

Abstract base class for sliders.

Description

Abstract base class for sliders, used to adjust a value by moving a grabber along a horizontal or vertical axis. Sliders are Range-based controls.

Properties

bool

editable

true

FocusMode

focus_mode

2 (overrides Control)

bool

scrollable

true

float

step

1.0 (overrides Range)

int

tick_count

0

bool

ticks_on_borders

false

Theme Properties

int

center_grabber

0

int

grabber_offset

0

Texture2D

grabber

Texture2D

grabber_disabled

Texture2D

grabber_highlight

Texture2D

tick

StyleBox

grabber_area

StyleBox

grabber_area_highlight

StyleBox

slider


Signals

drag_ended ( bool value_changed )

Emitted when dragging stops. If value_changed is true, Range.value is different from the value when you started the dragging.


drag_started ( )

Emitted when dragging is started.


Property Descriptions

bool editable = true

  • void set_editable ( bool value )

  • bool is_editable ( )

If true, the slider can be interacted with. If false, the value can be changed only by code.


bool scrollable = true

  • void set_scrollable ( bool value )

  • bool is_scrollable ( )

If true, the value can be changed using the mouse wheel.


int tick_count = 0

  • void set_ticks ( int value )

  • int get_ticks ( )

Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers.


bool ticks_on_borders = false

  • void set_ticks_on_borders ( bool value )

  • bool get_ticks_on_borders ( )

If true, the slider will display ticks for minimum and maximum values.


Theme Property Descriptions

int center_grabber = 0

Boolean constant. If 1, the grabber texture size will be ignored and it will fit within slider's bounds based only on its center position.


int grabber_offset = 0

Vertical or horizontal offset of the grabber.


Texture2D grabber

The texture for the grabber (the draggable element).


Texture2D grabber_disabled

The texture for the grabber when it's disabled.


Texture2D grabber_highlight

The texture for the grabber when it's focused.