Range

Inherits: Control < CanvasItem < Node < Object

Inherited By: EditorSpinSlider, ProgressBar, ScrollBar, Slider, SpinBox, TextureProgress

Abstract base class for range-based controls.

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.

Methods

voidshare ( Node with )
voidunshare ( )

Signals

  • changed ( )

Emitted when min_value, max_value, page, or step change.


  • value_changed ( float value )

Emitted when value changes.

Property Descriptions

Defaultfalse
Setterset_allow_greater(value)
Getteris_greater_allowed()

If true, value may be greater than max_value.


Defaultfalse
Setterset_allow_lesser(value)
Getteris_lesser_allowed()

If true, value may be less than min_value.


Defaultfalse
Setterset_exp_ratio(value)
Getteris_ratio_exp()

If true, and min_value is greater than 0, value will be represented exponentially rather than linearly.


Default100.0
Setterset_max(value)
Getterget_max()

Maximum value. Range is clamped if value is greater than max_value.


Default0.0
Setterset_min(value)
Getterget_min()

Minimum value. Range is clamped if value is less than min_value.


Default0.0
Setterset_page(value)
Getterget_page()

Page size. Used mainly for ScrollBar. ScrollBar’s length is its size multiplied by page over the difference between min_value and max_value.


Setterset_as_ratio(value)
Getterget_as_ratio()

The value mapped between 0 and 1.


Defaultfalse
Setterset_use_rounded_values(value)
Getteris_using_rounded_values()

If true, value will always be rounded to the nearest integer.


Default1.0
Setterset_step(value)
Getterget_step()

If greater than 0, value will always be rounded to a multiple of step. If rounded is also true, value will first be rounded to a multiple of step then rounded to the nearest integer.


Default0.0
Setterset_value(value)
Getterget_value()

Range’s current value.

Method Descriptions

  • void share ( 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 range from sharing its member variables with any other.

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.