Skip to main content

SuiScroller

Godot's ScrollContainer, but much simpler.

Variables​

SuiTypes.ScrollVisibility hscroll_visibility = SuiTypes.ScrollVisibility.AUTO​

Controls the visibility of the horizontal scroll bar.

SuiTypes.ScrollVisibility vscroll_visibility = SuiTypes.ScrollVisibility.AUTO​

Controls the visibility of the vertical scroll bar.

SuiTypes.ScrollMode speed_mode = SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE​

Determines how the scrolling speed should be calculated.

float speed_multiplier = 1.0​

The speed multiplier, used for SuiTypes.ScrollMode.MULTIPLY_VIEWPORT and SuiTypes.ScrollMode.CUSTOM_VALUE.

float speed_value = 1.0​

The speed value, used for SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE and SuiTypes.ScrollMode.CUSTOM_VALUE.

float speed_wheel_multiplier = 50.0​

Determines how much the scrolling speed should be multiplied by when scrolling with the scroll wheel.
Using a lower value results in more mouse scrolling, higher values result in less mouse scrolling.

SuiTypes.ScrollMode thickness_mode = SuiTypes.ScrollMode.MULTIPLY_VIEWPORT​

Determines how the thickness of both scroll bars should be calculated.

float thickness_multiplier = 0.025​

The thickness multiplier, used for SuiTypes.ScrollMode.MULTIPLY_VIEWPORT and SuiTypes.ScrollMode.CUSTOM_VALUE.

float thickness_value = 0.0​

The thickness value, used for SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE and SuiTypes.ScrollMode.CUSTOM_VALUE.

bool editor_clip_content = true​

Will cause elements not inside the SuiScroller node to be no longer clipped in editor mode.
Useful when editing the contents of a SuiScroller node, but may cause visual chaos.

bool editor_process = true​

Determines if the element should be updated automatically while running in the editor.

bool runtime_process = true​

Determines if the element should be updated automatically during your game/application's runtime.

Functions​

void update_element()​

Updates the element.