Class reference
Range
Inherits Control
Abstract base class for controls that represent a number within a range.
Description
Range is an abstract base class for controls that represent a number within a range, using a configured step and page size. See e.g. ScrollBar and Slider for examples of higher-level nodes using Range.
Properties
bool allow_greater = false
bool allow_greater = falsebool allow_lesser = false
bool allow_lesser = falsebool exp_edit = false
bool exp_edit = falseIf true, and min_value is greater or equal to 0, value will be represented exponentially rather than linearly.
float max_value = 100.0
float max_value = 100.0Maximum value. Range is clamped if value is greater than max_value.
float min_value = 0.0
float min_value = 0.0Minimum value. Range is clamped if value is less than min_value.
float page = 0.0
float page = 0.0Page size. Used mainly for ScrollBar. A ScrollBar's grabber length is the ScrollBar's size multiplied by page over the difference between min_value and max_value.
float ratio
float ratioThe value mapped between 0 and 1.
bool rounded = false
bool rounded = falseIf true, value will always be rounded to the nearest integer.
int size_flags_vertical = 0
int size_flags_vertical = 0float step = 0.01
float step = 0.01If greater than 0, value will always be rounded to a multiple of this property's value above min_value. For example, if min_value is 0.1 and step is 0.2, then value is limited to 0.1, 0.3, 0.5, and so on. If rounded is also true, value will first be rounded to a multiple of this property's value, then rounded to the nearest integer.
float value = 0.0
float value = 0.0Range's current value. Changing this property (even via code) will trigger value_changed signal. Use set_value_no_signal() if you want to avoid it.
Methods
void _value_changed(float new_value) virtual
float new_value) virtualCalled when the Range's value is changed (following the same conditions as value_changed).
void set_value_no_signal(float value)
float value)Sets the Range's current value to the specified value, without emitting the value_changed signal.
void share(Node with)
Node with)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.
void unshare()
Stops the Range from sharing its member variables with any other.
Signals
changed()
value_changed(float value)
float value)Emitted when value changes. When used on a Slider, this is called continuously while dragging (potentially every frame). If you are performing an expensive operation in a function connected to value_changed, consider using a debouncing Timer to call the function less often. Note: Unlike signals such as LineEdit.text_changed, value_changed is also emitted when value is set directly via code.