Range¶
Inherits: Control < CanvasItem < Node < Object
Inherited By: SpinBox, ScrollBar, ProgressBar, TextureProgress, Slider
Category: Core
Brief Description¶
Abstract base class for range-based controls.
Signals¶
- changed ( )
This signal is emitted when min, max, range or step change.
- value_changed ( float value )
This signal is emitted when value changes.
Member Variables¶
- bool exp_edit - If
true
andmin_value
is greater than 0,value
will be represented exponentially rather than linearly. - float max_value - Maximum value. Range is clamped if
value
is greater thanmax_value
. Default value: 100. - float min_value - Minimum value. Range is clamped if
value
is less thanmin_value
. Default value: 0. - float page - Page size. Used mainly for ScrollBar. ScrollBar’s length is its size multiplied by
page
over the difference betweenmin_value
andmax_value
. - float ratio - The value mapped between 0 and 1.
- bool rounded - If
true
,value
will always be rounded to the nearest integer. - float step - If greater than 0,
value
will always be rounded to a multiple ofstep
. Ifrounded
is alsotrue
,value
will first be rounded to a multiple ofstep
then rounded to the nearest integer. - float value - Range’s current value.
Description¶
Range is a base class for Control nodes that change a floating point value between a minimum and a maximum, using step and page, for example a ScrollBar.
Member Function Description¶
Binds two Ranges together along with any Ranges previously grouped with either of them. When any of Range’s member variables change, it will share the new value with all other Ranges in its group.
Stop Range from sharing its member variables with any other Range.