Skip to content

AutoScroll.md

Latest commit

 

History

History
85 lines (49 loc) · 3.88 KB

AutoScroll.md

File metadata and controls

85 lines (49 loc) · 3.88 KB

:github_url: hide

AutoScroll

Inherits: Control

Node adding auto scrolling feature to its Range parent.

Description

This node takes its parent Range and changes Range.value with constant speed until it reaches its destination. You can specify destination with scroll_to method.

Properties
float auto_min_value inf_neg
float speed 10.0

Methods
bool is_scrolling( )
void scroll_to( value: float )

Property Descriptions

float auto_min_value = inf_neg

  • void set_auto_min_value( value: float )
  • float get_auto_min_value( )

Defines minimum destination value. See scroll_to for more details.

float speed = 10.0

  • void set_speed( value: float )
  • float get_speed( )

Defines speed of auto scrolling.

Method Descriptions

bool is_scrolling( )

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

void scroll_to( value: float )

Sets destination to value and instantly starts auto scrolling process. If value is lesser than auto_min_value it is changed to match it.