|
@@ -1,10 +1,10 @@
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
|
|
<class name="Range" inherits="Control" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
|
<brief_description>
|
|
|
- Abstract base class for range-based controls.
|
|
|
+ Abstract base class for controls that represent a number within a range.
|
|
|
</brief_description>
|
|
|
<description>
|
|
|
- Range is a base class for [Control] nodes that change a floating-point [member value] between a [member min_value] and [member max_value], using a configured [member step] and [member page] size. See e.g. [ScrollBar] and [Slider] for examples of higher level nodes using Range.
|
|
|
+ Range is an abstract base class for controls that represent a number within a range, using a configured [member step] and [member page] size. See e.g. [ScrollBar] and [Slider] for examples of higher-level nodes using Range.
|
|
|
</description>
|
|
|
<tutorials>
|
|
|
</tutorials>
|
|
@@ -45,26 +45,26 @@
|
|
|
If [code]true[/code], [member value] may be less than [member min_value].
|
|
|
</member>
|
|
|
<member name="exp_edit" type="bool" setter="set_exp_ratio" getter="is_ratio_exp" default="false">
|
|
|
- If [code]true[/code], and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly.
|
|
|
+ If [code]true[/code], and [member min_value] is greater than 0, [member value] will be represented exponentially rather than linearly.
|
|
|
</member>
|
|
|
<member name="max_value" type="float" setter="set_max" getter="get_max" default="100.0">
|
|
|
- Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code].
|
|
|
+ Maximum value. Range is clamped if [member value] is greater than [member max_value].
|
|
|
</member>
|
|
|
<member name="min_value" type="float" setter="set_min" getter="get_min" default="0.0">
|
|
|
- Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code].
|
|
|
+ Minimum value. Range is clamped if [member value] is less than [member min_value].
|
|
|
</member>
|
|
|
<member name="page" type="float" setter="set_page" getter="get_page" default="0.0">
|
|
|
- Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code].
|
|
|
+ Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [member page] over the difference between [member min_value] and [member max_value].
|
|
|
</member>
|
|
|
<member name="ratio" type="float" setter="set_as_ratio" getter="get_as_ratio">
|
|
|
The value mapped between 0 and 1.
|
|
|
</member>
|
|
|
<member name="rounded" type="bool" setter="set_use_rounded_values" getter="is_using_rounded_values" default="false">
|
|
|
- If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer.
|
|
|
+ If [code]true[/code], [member value] will always be rounded to the nearest integer.
|
|
|
</member>
|
|
|
<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" overrides="Control" enum="Control.SizeFlags" default="0" />
|
|
|
<member name="step" type="float" setter="set_step" getter="get_step" default="0.01">
|
|
|
- If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer.
|
|
|
+ If greater than 0, [member value] will always be rounded to a multiple of this property's value. If [member rounded] is also [code]true[/code], [member value] will first be rounded to a multiple of this property's value, then rounded to the nearest integer.
|
|
|
</member>
|
|
|
<member name="value" type="float" setter="set_value" getter="get_value" default="0.0">
|
|
|
Range's current value. Changing this property (even via code) will trigger [signal value_changed] signal. Use [method set_value_no_signal] if you want to avoid it.
|