Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

EditorSpinSlider

Inherits: Range < Control < CanvasItem < Node < Object

Godot editor's control for editing numeric values.

Description

This Control node is used in the editor's Inspector dock to allow editing of numeric values. Can be used with EditorInspectorPlugin to recreate the same behavior.

If the Range.step value is 1, the EditorSpinSlider will display up/down arrows, similar to SpinBox. If the Range.step value is not 1, a slider will be displayed instead.

Properties

bool

editing_integer

false

bool

flat

false

FocusMode

focus_mode

2 (overrides Control)

bool

hide_slider

false

String

label

""

bool

read_only

false

BitField[SizeFlags]

size_flags_vertical

1 (overrides Control)

float

step

1.0 (overrides Range)

String

suffix

""

Theme Properties

Texture2D

updown

Texture2D

updown_disabled

Signals

grabbed() 🔗

Emitted when the spinner/slider is grabbed.

ungrabbed() 🔗

Emitted when the spinner/slider is ungrabbed.

updown_pressed() 🔗

Emitted when the updown button is pressed.

value_focus_entered() 🔗

Emitted when the value form gains focus.

value_focus_exited() 🔗

Emitted when the value form loses focus.

Property Descriptions

bool editing_integer = false 🔗

  • void set_editing_integer(value: bool)

  • bool is_editing_integer()

If true, the EditorSpinSlider is considered to be editing an integer value. If false, the EditorSpinSlider is considered to be editing a floating-point value. This is used to determine whether a slider should be drawn. The slider is only drawn for floats; integers use up-down arrows similar to SpinBox instead.

bool flat = false 🔗

  • void set_flat(value: bool)

  • bool is_flat()

If true, the slider will not draw background.

bool hide_slider = false 🔗

  • void set_hide_slider(value: bool)

  • bool is_hiding_slider()

If true, the slider and up/down arrows are hidden.

String label = "" 🔗

The text that displays to the left of the value.

bool read_only = false 🔗

  • void set_read_only(value: bool)

  • bool is_read_only()

If true, the slider can't be interacted with.

String suffix = "" 🔗

The suffix to display after the value (in a faded color). This should generally be a plural word. You may have to use an abbreviation if the suffix is too long to be displayed.

Theme Property Descriptions

Texture2D updown 🔗

Single texture representing both the up and down buttons.

Texture2D updown_disabled 🔗

Single texture representing both the up and down buttons, when the control is readonly or disabled.