StarOpenSource/SUI
StarOpenSource/SUI
2
0
Fork 0
Code Issues Pull requests Releases Activity

Add missing SuiScroller online documentation page

Browse source
This commit is contained in:
JeremyStar™ 2024-05-10 15:25:22 +02:00
parent f3e112faeb
commit 0172c142c8
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
1 changed files with 38 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
docs/docs/reference/elements/scroller.md Normal file
View file

@ -0,0 +1,38 @@
---
sidebar_position: 4
---
# `SuiScroller`
Godot's `ScrollContainer`, but *much* simpler.
## Variables
### *SuiTypes.ScrollVisibility* <u>hscroll_visibility</u> = *SuiTypes.ScrollVisibility.AUTO*
Controls the visibility of the horizontal scroll bar.
### *SuiTypes.ScrollVisibility* <u>vscroll_visibility</u> = *SuiTypes.ScrollVisibility.AUTO*
Controls the visibility of the vertical scroll bar.
### *SuiTypes.ScrollMode* <u>speed_mode</u> = *SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE*
Determines how the scrolling speed should be calculated.
### *float* <u>speed_multiplier</u> = *1.0*
The speed multiplier, used for `SuiTypes.ScrollMode.MULTIPLY_VIEWPORT` and `SuiTypes.ScrollMode.CUSTOM_VALUE`.
### *float* <u>speed_value</u> = *1.0*
The speed value, used for `SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE` and `SuiTypes.ScrollMode.CUSTOM_VALUE`.
### *float* <u>speed_wheel_multiplier</u> = *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* <u>thickness_mode</u> = *SuiTypes.ScrollMode.MULTIPLY_VIEWPORT*
Determines how the thickness of both scroll bars should be calculated.
### *float* <u>thickness_multiplier</u> = *0.025*
The thickness multiplier, used for `SuiTypes.ScrollMode.MULTIPLY_VIEWPORT` and `SuiTypes.ScrollMode.CUSTOM_VALUE`.
### *float* <u>thickness_value</u> = *0.0*
The thickness value, used for `SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE` and `SuiTypes.ScrollMode.CUSTOM_VALUE`.
### *bool* <u>editor_clip_content</u> = *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* <u>editor_process</u> = *true*
Determines if the element should be updated automatically **while running in the editor**.
### *bool* <u>runtime_process</u> = *true*
Determines if the element should be updated automatically **during your game/application's runtime**.
## Functions
### *void* <u>update_element</u>()
Updates the element.