:github_url: hide

<!---
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/Godot-CCP/doc_classes/AutoScroll.xml.

.. _class_AutoScroll:

-->
<a name="TOP"></a>

# AutoScroll

**Inherits:** [Control](https://docs.godotengine.org/en/stable/classes/class_control.html)

Node adding auto scrolling feature to its [Range](https://docs.godotengine.org/en/stable/classes/class_range.html) parent.

<a name="Description"></a>

## Description

This node takes its parent [Range](https://docs.godotengine.org/en/stable/classes/class_range.html) and changes [Range.value](https://docs.godotengine.org/en/stable/classes/class_range.html#class_range_member_value) with constant [speed](./autoscroll.md#property_speed) until it reaches its destination. You can specify destination with [scroll_to](./autoscroll.md#method_scroll_to) method.

<a name="Properties"></a>

## Properties

|                                                                          |                                            |             |
|--------------------------------------------------------------------------|--------------------------------------------|-------------|
| [float](https://docs.godotengine.org/en/stable/classes/class_float.html) | [auto_min_value](#property_auto_min_value) | ``inf_neg`` |
| [float](https://docs.godotengine.org/en/stable/classes/class_float.html) | [speed](#property_speed)                   | ``10.0``    |

<a name="Methods"></a>

## Methods

|                                                                        |                                                                                                                                   |
|------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html) | [is_scrolling](./AutoScroll.md#method_is_scrolling)( )                                                                            |
| *void*                                                                 | [scroll_to](./AutoScroll.md#method_scroll_to)( value\: [float](https://docs.godotengine.org/en/stable/classes/class_float.html) ) |

---

<a name="PropertyDescriptions"></a>

## Property Descriptions

<a name="property_auto_min_value"></a>

#### [float](https://docs.godotengine.org/en/stable/classes/class_float.html) **auto_min_value** = ``inf_neg``

- *void* **set_auto_min_value**( value\: [float](https://docs.godotengine.org/en/stable/classes/class_float.html) )
- [float](https://docs.godotengine.org/en/stable/classes/class_float.html) **get_auto_min_value**( )

Defines minimum destination value. See [scroll_to](./autoscroll.md#method_scroll_to) for more details.

<a name="property_speed"></a>

#### [float](https://docs.godotengine.org/en/stable/classes/class_float.html) **speed** = ``10.0``

- *void* **set_speed**( value\: [float](https://docs.godotengine.org/en/stable/classes/class_float.html) )
- [float](https://docs.godotengine.org/en/stable/classes/class_float.html) **get_speed**( )

Defines speed of auto scrolling.

---

<a name="MethodDescriptions"></a>

## Method Descriptions

<a name="method_is_scrolling"></a>

#### [bool](https://docs.godotengine.org/en/stable/classes/class_bool.html) **is_scrolling**( )

Returns ``false`` if is inactive(already has reached its destination).

<a name="method_scroll_to"></a>

#### *void* **scroll_to**( value\: [float](https://docs.godotengine.org/en/stable/classes/class_float.html) )

Sets destination to ``value`` and instantly starts auto scrolling process. If ``value`` is lesser than [auto_min_value](./autoscroll.md#property_auto_min_value) it is changed to match it.