W3cubDocs

/Godot 3.1

SpinBox

Inherits: Range < Control < CanvasItem < Node < Object

Category: Core

Brief Description

Numerical input text field.

Properties

Align align
bool editable
String prefix
String suffix

Methods

LineEdit get_line_edit ( )

Theme Properties

Texture updown

Description

SpinBox is a numerical input text field. It allows entering integers and floats.

Example:

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.align = LineEdit.ALIGN_RIGHT

The above code will create a SpinBox, disable context menu on it and set the text alignment to right.

See Range class for more options over the SpinBox.

Property Descriptions

Align align

Setter set_align(value)
Getter get_align()

Sets the text alignment of the SpinBox.

bool editable

Setter set_editable(value)
Getter is_editable()

If true, the SpinBox will be editable. Otherwise, it will be read only.

String prefix

Setter set_prefix(value)
Getter get_prefix()

Adds the specified prefix string before the numerical value of the SpinBox.

String suffix

Setter set_suffix(value)
Getter get_suffix()

Adds the specified prefix string after the numerical value of the SpinBox.

Method Descriptions

LineEdit get_line_edit ( )

Returns the LineEdit instance from this SpinBox. You can use it to access properties and methods of LineEdit.

© 2014–2019 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
http://docs.godotengine.org/en/3.1/classes/class_spinbox.html