godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch

Browse Source
This commit is contained in:
Rémi Verschelde
2017-04-07 22:11:07 +02:00
parent 447b439db5
commit c282b77a58
392 changed files with 14087 additions and 12472 deletions
Download Patch File Download Diff File Expand all files Collapse all files

139
classes/class_range.rst
View File

@@ -20,47 +20,43 @@ Abstract base class for range-based controls.
Member Functions
----------------
+----------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_max<class_Range_get_max>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_min<class_Range_get_min>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_page<class_Range_get_page>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_step<class_Range_get_step>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_unit_value<class_Range_get_unit_value>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_val<class_Range_get_val>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_value<class_Range_get_value>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_rounded_values<class_Range_is_rounded_values>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_unit_value_exp<class_Range_is_unit_value_exp>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_exp_unit_value<class_Range_set_exp_unit_value>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_max<class_Range_set_max>` **(** :ref:`float<class_float>` maximum **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_min<class_Range_set_min>` **(** :ref:`float<class_float>` minimum **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_page<class_Range_set_page>` **(** :ref:`float<class_float>` pagesize **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rounded_values<class_Range_set_rounded_values>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_step<class_Range_set_step>` **(** :ref:`float<class_float>` step **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_unit_value<class_Range_set_unit_value>` **(** :ref:`float<class_float>` value **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_val<class_Range_set_val>` **(** :ref:`float<class_float>` value **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_value<class_Range_set_value>` **(** :ref:`float<class_float>` value **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`share<class_Range_share>` **(** :ref:`Object<class_object>` with **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`unshare<class_Range_unshare>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_as_ratio<class_Range_get_as_ratio>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_max<class_Range_get_max>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_min<class_Range_get_min>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_page<class_Range_get_page>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_step<class_Range_get_step>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_value<class_Range_get_value>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_ratio_exp<class_Range_is_ratio_exp>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_using_rounded_values<class_Range_is_using_rounded_values>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_ratio<class_Range_set_as_ratio>` **(** :ref:`float<class_float>` value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_exp_ratio<class_Range_set_exp_ratio>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_max<class_Range_set_max>` **(** :ref:`float<class_float>` maximum **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_min<class_Range_set_min>` **(** :ref:`float<class_float>` minimum **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_page<class_Range_set_page>` **(** :ref:`float<class_float>` pagesize **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_step<class_Range_set_step>` **(** :ref:`float<class_float>` step **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_rounded_values<class_Range_set_use_rounded_values>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_value<class_Range_set_value>` **(** :ref:`float<class_float>` value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`share<class_Range_share>` **(** :ref:`Object<class_object>` with **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`unshare<class_Range_unshare>` **(** **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -68,6 +64,17 @@ Signals
- **changed** **(** **)**
- **value_changed** **(** :ref:`float<class_float>` value **)**
Member Variables
----------------
- :ref:`bool<class_bool>` **exp_edit**
- :ref:`float<class_float>` **max_value**
- :ref:`float<class_float>` **min_value**
- :ref:`float<class_float>` **page**
- :ref:`bool<class_bool>` **rounded**
- :ref:`float<class_float>` **step**
- :ref:`float<class_float>` **value**
Description
-----------
@@ -76,6 +83,12 @@ Range is a base class for :ref:`Control<class_control>` nodes that change a floa
Member Function Description
---------------------------
.. _class_Range_get_as_ratio:
- :ref:`float<class_float>` **get_as_ratio** **(** **)** const
Return value mapped to 0 to 1 range.
.. _class_Range_get_max:
- :ref:`float<class_float>` **get_max** **(** **)** const
@@ -100,33 +113,27 @@ Return the page size, if page is 0, paging is disabled.
Return the stepping, if step is 0, stepping is disabled.
.. _class_Range_get_unit_value:
- :ref:`float<class_float>` **get_unit_value** **(** **)** const
Return value mapped to 0 to 1 (unit) range.
.. _class_Range_get_val:
- :ref:`float<class_float>` **get_val** **(** **)** const
Return the current value.
.. _class_Range_get_value:
- :ref:`float<class_float>` **get_value** **(** **)** const
.. _class_Range_is_rounded_values:
.. _class_Range_is_ratio_exp:
- :ref:`bool<class_bool>` **is_rounded_values** **(** **)** const
- :ref:`bool<class_bool>` **is_ratio_exp** **(** **)** const
.. _class_Range_is_unit_value_exp:
.. _class_Range_is_using_rounded_values:
- :ref:`bool<class_bool>` **is_unit_value_exp** **(** **)** const
- :ref:`bool<class_bool>` **is_using_rounded_values** **(** **)** const
.. _class_Range_set_exp_unit_value:
.. _class_Range_set_as_ratio:
- void **set_exp_unit_value** **(** :ref:`bool<class_bool>` enabled **)**
- void **set_as_ratio** **(** :ref:`float<class_float>` value **)**
Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max.
.. _class_Range_set_exp_ratio:
- void **set_exp_ratio** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_Range_set_max:
@@ -144,25 +151,15 @@ Set minimum value, clamped range value to it if it's less.
Set page size. Page is mainly used for scrollbars or anything that controls text scrolling.
.. _class_Range_set_rounded_values:
- void **set_rounded_values** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_Range_set_step:
- void **set_step** **(** :ref:`float<class_float>` step **)**
Set step value. If step is 0, stepping will be disabled.
.. _class_Range_set_unit_value:
.. _class_Range_set_use_rounded_values:
- void **set_unit_value** **(** :ref:`float<class_float>` value **)**
Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max.
.. _class_Range_set_val:
- void **set_val** **(** :ref:`float<class_float>` value **)**
- void **set_use_rounded_values** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_Range_set_value: