Range

Inherited By: , ProgressBar, , Slider, , TextureProgress

Abstract base class for range-based controls.

Range is a base class for nodes that change a floating-point value between a minimum and a maximum, using step and page, for example a ScrollBar.

Properties

void	( Node with )
void	( )

Signals

Emitted when min_value, , page, or change.

value_changed ( float value )

Emitted when changes.

bool allow_greater

Default	`false`
Setter	set_allow_greater(value)
Getter	is_greater_allowed()

allow_lesser

Default	`false`
Setter	set_allow_lesser(value)
Getter	is_lesser_allowed()

If , value may be less than .

bool exp_edit

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

max_value

Default	`100.0`
Setter	set_max(value)
Getter	get_max()

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

float min_value

Default	`0.0`
Setter	set_min(value)
Getter	get_min()

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

Default	`0.0`
Setter	set_page(value)
Getter	get_page()

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

float ratio

rounded

Default	`false`
Setter	set_use_rounded_values(value)
Getter	is_using_rounded_values()

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

float step

Default	`1.0`
Setter	set_step(value)
Getter	get_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 then rounded to the nearest integer.

value

Default	`0.0`
Setter	set_value(value)
Getter	get_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.