Compare commits

...

3 commits

7 changed files with 49 additions and 7 deletions

View file

@ -1,5 +1,6 @@
--- ---
sidebar_position: 0 sidebar_position: 0
description: Useful for headings.
--- ---
# `SuiHeader` # `SuiHeader`

View file

@ -1,5 +1,6 @@
--- ---
sidebar_position: 3 sidebar_position: 3
description: Useful for buttons with icons.
--- ---
# `SuiIconButton` # `SuiIconButton`

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.

View file

@ -1,5 +1,6 @@
--- ---
sidebar_position: 1 sidebar_position: 1
description: Useful for text.
--- ---
# `SuiText` # `SuiText`

View file

@ -1,5 +1,6 @@
--- ---
sidebar_position: 2 sidebar_position: 2
description: Useful for buttons with text.
--- ---
# `SuiTextButton` # `SuiTextButton`

View file

@ -19,10 +19,10 @@ script = ExtResource("1_dcfql")
modulate = Color(1, 1, 1, 0.501961) modulate = Color(1, 1, 1, 0.501961)
layout_mode = 1 layout_mode = 1
offset_top = 226.417 offset_top = 226.417
offset_right = 366.417 offset_right = 366.42
offset_bottom = 246.667 offset_bottom = 246.667
theme = ExtResource("2_4lteo") theme = ExtResource("2_4lteo")
max_value = 386.667 max_value = 386.67
step = 1.0 step = 1.0
page = 1.0 page = 1.0

View file

@ -12,20 +12,20 @@ extends SuiBaseClass
## Determines how the scrolling speed should be calculated. ## Determines how the scrolling speed should be calculated.
@export var speed_mode: SuiTypes.ScrollMode = SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE @export var speed_mode: SuiTypes.ScrollMode = SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE
## The speed multiplier, used for [constant SuiTypes.ScrollMode.MULTIPLY_VIEWPORT] and [constant SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE]. ## The speed multiplier, used for [constant SuiTypes.ScrollMode.MULTIPLY_VIEWPORT] and [constant SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE].
@export var speed_multiplier: float = 1 @export var speed_multiplier: float = 1.0
## The speed value, used for [constant SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE] and [constant SuiTypes.ScrollMode.CUSTOM_VALUE]. ## The speed value, used for [constant SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE] and [constant SuiTypes.ScrollMode.CUSTOM_VALUE].
@export var speed_value: float = 1 @export var speed_value: float = 1.0
@export_subgroup("Scroller speed (wheel)") @export_subgroup("Scroller speed (wheel)")
## Determines how much the scrolling speed should be multiplied by when scrolling with the scroll wheel. ## Determines how much the scrolling speed should be multiplied by when scrolling with the scroll wheel.[br]
## Using a lower value results in more mouse scrolling, higher values result in less mouse scrolling. ## Using a lower value results in more mouse scrolling, higher values result in less mouse scrolling.
@export var speed_wheel_multiplier: float = 50 @export var speed_wheel_multiplier: float = 50.0
@export_subgroup("Scroll bar thickness") @export_subgroup("Scroll bar thickness")
## Determines how the thickness of both scroll bars should be calculated. ## Determines how the thickness of both scroll bars should be calculated.
@export var thickness_mode: SuiTypes.ScrollMode = SuiTypes.ScrollMode.MULTIPLY_VIEWPORT @export var thickness_mode: SuiTypes.ScrollMode = SuiTypes.ScrollMode.MULTIPLY_VIEWPORT
## The thickness multiplier, used for [constant SuiTypes.ScrollMode.MULTIPLY_VIEWPORT] and [constant SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE]. ## The thickness multiplier, used for [constant SuiTypes.ScrollMode.MULTIPLY_VIEWPORT] and [constant SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE].
@export var thickness_multiplier: float = 0.025 @export var thickness_multiplier: float = 0.025
## The thickness value, used for [constant SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE] and [constant SuiTypes.ScrollMode.CUSTOM_VALUE]. ## The thickness value, used for [constant SuiTypes.ScrollMode.MULTIPLY_CUSTOM_VALUE] and [constant SuiTypes.ScrollMode.CUSTOM_VALUE].
@export var thickness_value: float = 0 @export var thickness_value: float = 0.0
@export_category("Debugging") @export_category("Debugging")
## Will cause elements not inside the SuiScroller node to be no longer clipped [i]in editor mode[/i]. ## Will cause elements not inside the SuiScroller node to be no longer clipped [i]in editor mode[/i].
## Useful when editing the contents of a SuiScroller node, but may cause visual chaos. ## Useful when editing the contents of a SuiScroller node, but may cause visual chaos.