An input field for numbers.
[SpinBox] is a numerical input text field. It allows entering integers and floating-point numbers. The [SpinBox] also has up and down buttons that can be clicked increase or decrease the value. The value can also be changed by dragging the mouse up or down over the [SpinBox]'s arrows. Additionally, mathematical expressions can be entered. These are evaluated when the user presses [kbd]Enter[/kbd] while editing the [SpinBox]'s text field. This uses the [Expression] class to parse and evaluate the expression. The result of the expression is then set as the value of the [SpinBox]. Some examples of valid expressions are [code]5 + 2 * 3[/code], [code]pow(2, 4)[/code], and [code]PI + sin(0.5)[/code]. Expressions are case-sensitive. [b]Example:[/b] Create a [SpinBox], disable its context menu and set its text alignment to right. [codeblocks] [gdscript] var spin_box = SpinBox.new() add_child(spin_box) var line_edit = spin_box.get_line_edit() line_edit.context_menu_enabled = false spin_box.horizontal_alignment = LineEdit.HORIZONTAL_ALIGNMENT_RIGHT [/gdscript] [csharp] var spinBox = new SpinBox(); AddChild(spinBox); var lineEdit = spinBox.GetLineEdit(); lineEdit.ContextMenuEnabled = false; spinBox.AlignHorizontal = LineEdit.HorizontalAlignEnum.Right; [/csharp] [/codeblocks] See [Range] class for more options over the [SpinBox]. [b]Note:[/b] With the [SpinBox]'s context menu disabled, you can right-click the bottom half of the spinbox to set the value to its minimum, while right-clicking the top half sets the value to its maximum. [b]Note:[/b] [SpinBox] relies on an underlying [LineEdit] node. To theme a [SpinBox]'s background, add theme items for [LineEdit] and customize them. The [LineEdit] has the [code]SpinBoxInnerLineEdit[/code] theme variation, so that you can give it a distinct appearance from regular [LineEdit]s. [b]Note:[/b] If you want to implement drag and drop for the underlying [LineEdit], you can use [method Control.set_drag_forwarding] on the node returned by [method get_line_edit].
Applies the current value of this [SpinBox]. This is equivalent to pressing [kbd]Enter[/kbd] while editing the [LineEdit] used by the [SpinBox]. This will cause [signal LineEdit.text_submitted] to be emitted and its currently contained expression to be evaluated.
Returns the [LineEdit] instance from this [SpinBox]. You can use it to access properties and methods of [LineEdit]. [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.
- Changes the alignment of the underlying [LineEdit].
- If [code]true[/code], the value will be rounded to a multiple of [member custom_arrow_step] when interacting with the arrow buttons. Otherwise, increments the value by [member custom_arrow_step] and then rounds it according to [member Range.step].
- If not [code]0[/code], sets the step when interacting with the arrow buttons of the [SpinBox]. [b]Note:[/b] [member Range.value] will still be rounded to a multiple of [member Range.step].
- If [code]true[/code], the [SpinBox] will be editable. Otherwise, it will be read only.
- Adds the specified prefix string before the numerical value of the [SpinBox].
- If [code]true[/code], the [SpinBox] will select the whole text when the [LineEdit] gains focus. Clicking the up and down arrows won't trigger this behavior.
- Adds the specified suffix string after the numerical value of the [SpinBox].
- Sets the value of the [Range] for this [SpinBox] when the [LineEdit] text is [i]changed[/i] instead of [i]submitted[/i]. See [signal LineEdit.text_changed] and [signal LineEdit.text_submitted]. [b]Note:[/b] If set to [code]true[/code], this will interfere with entering mathematical expressions in the [SpinBox]. The [SpinBox] will try to evaluate the expression as you type, which means symbols like a trailing [code]+[/code] are removed immediately by the expression being evaluated.
Down button icon modulation color, when the button is disabled.
Down button icon modulation color, when the button is hovered.
Down button icon modulation color.
Down button icon modulation color, when the button is being pressed.
Up button icon modulation color, when the button is disabled.
Up button icon modulation color, when the button is hovered.
Up button icon modulation color.
Up button icon modulation color, when the button is being pressed.
Vertical separation between the up and down buttons.
Width of the up and down buttons. If smaller than any icon set on the buttons, the respective icon may overlap neighboring elements. If smaller than [code]0[/code], the width is automatically adjusted from the icon size.
Width of the horizontal separation between the text input field ([LineEdit]) and the buttons.
If not [code]0[/code], the minimum button width corresponds to the widest of all icons set on those buttons, even if [theme_item buttons_width] is smaller.
Down button icon, displayed in the middle of the down (value-decreasing) button.
Down button icon when the button is disabled.
Down button icon when the button is hovered.
Down button icon when the button is being pressed.
Up button icon, displayed in the middle of the up (value-increasing) button.
Up button icon when the button is disabled.
Up button icon when the button is hovered.
Up button icon when the button is being pressed.
Single texture representing both the up and down buttons icons. It is displayed in the middle of the buttons and does not change upon interaction. If a valid icon is assigned, it will replace [theme_item up] and [theme_item down].
Background style of the down button.
Background style of the down button when disabled.
Background style of the down button when hovered.
Background style of the down button when being pressed.
[StyleBox] drawn in the space occupied by the separation between the input field and the buttons.
Background style of the up button.
Background style of the up button when disabled.
Background style of the up button when hovered.
Background style of the up button when being pressed.
[StyleBox] drawn in the space occupied by the separation between the up and down buttons.