Class EditorSpinSlider

Godot editor's control for editing numeric values.

Inheritance

Range

Control

CanvasItem

Node

Object

EditorSpinSlider

Remarks

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 step value is 1, the EditorSpinSlider will display up/down arrows, similar to SpinBox. If the step value is not 1, a slider will be displayed instead.

Properties

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.

var editing_integer : bool = false

Property Value

bool

Remarks

• void set_editing_integer(bool value)
• bool is_editing_integer

flat

If true, the slider will not draw background.

var flat : bool = false

Property Value

bool

Remarks

• void set_flat(bool value)
• bool is_flat

hide_slider

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

var hide_slider : bool = false

Property Value

bool

Remarks

• void set_hide_slider(bool value)
• bool is_hiding_slider

label

The text that displays to the left of the value.

var label : String = ""

Property Value

String

Remarks

• void set_label(String value)
• String get_label

read_only

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

var read_only : bool = false

Property Value

bool

Remarks

• void set_read_only(bool value)
• bool is_read_only

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.

var suffix : String = ""

Property Value

String

Remarks

• void set_suffix(String value)
• String get_suffix

updown

Theme Property

Single texture representing both the up and down buttons.

Texture2D updown

Property Value

Texture2D

updown_disabled

Theme Property

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

Texture2D updown_disabled

Property Value

Texture2D

Events

grabbed

Emitted when the spinner/slider is grabbed.

signal grabbed

ungrabbed

Emitted when the spinner/slider is ungrabbed.

signal ungrabbed

updown_pressed

Emitted when the updown button is pressed.

signal updown_pressed

value_focus_entered

Emitted when the value form gains focus.

signal value_focus_entered

value_focus_exited

Emitted when the value form loses focus.

signal value_focus_exited