Range

Inherits: Control < CanvasItem < Node < Object

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

Abstract base class for range-based controls.

Description

Range is a base class for Control nodes that change a floating-point value between a min_value and max_value, 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

bool

allow_lesser

bool

exp_edit

float

max_value

float

min_value

float

page

float

ratio

bool

rounded

float

step

float

value

Methods

void

_value_changed ( float new_value ) virtual

void

share ( Node with )

void

unshare ( )

Signals

  • changed ( )

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


  • value_changed ( 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.

Property Descriptions

  • bool allow_greater

Setter

set_allow_greater(value)

Getter

is_greater_allowed()

If true, value may be greater than max_value.


Setter

set_allow_lesser(value)

Getter

is_lesser_allowed()

If true, value may be less than min_value.


Setter

set_exp_ratio(value)

Getter

is_ratio_exp()

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


Setter

set_max(value)

Getter

get_max()

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


Setter

set_min(value)

Getter

get_min()

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


Setter

set_page(value)

Getter

get_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.


Setter

set_as_ratio(value)

Getter

get_as_ratio()

The value mapped between 0 and 1.


Setter

set_use_rounded_values(value)

Getter

is_using_rounded_values()

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


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 step then rounded to the nearest integer.


Setter

set_value(value)

Getter

get_value()

Range's current value.

Method Descriptions

  • void _value_changed ( float new_value ) virtual

Called when the Range's value is changed (following the same conditions as value_changed).


  • 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 the Range from sharing its member variables with any other.