From 18070404b2a8c2fb24f01431a6e9a1087396a1c5 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Fri, 10 May 2024 14:28:52 +0200 Subject: [PATCH] Sync online documentation --- docs/docs/about.md | 4 +- docs/docs/getting-started/_category_.json | 2 +- docs/docs/getting-started/setting-up.mdx | 3 + docs/docs/reference/_category_.json | 4 +- docs/docs/reference/classes/_category_.json | 8 +++ docs/docs/reference/classes/baseclass.md | 40 +++++++++++++ docs/docs/reference/classes/types.md | 27 +++++++++ docs/docs/reference/elements/_category_.json | 8 +++ docs/docs/reference/elements/header.md | 21 +++++++ docs/docs/reference/elements/iconbutton.md | 57 ++++++++++++++++++ docs/docs/reference/elements/text.md | 35 +++++++++++ .../reference/{ => elements}/textbutton.md | 22 +++---- docs/docs/reference/header.md | 22 ------- docs/docs/reference/iconbutton.md | 60 ------------------- docs/docs/reference/text.md | 30 ---------- docs/package.json | 28 ++++----- sui/src/SuiBaseClass.gd | 22 ++++--- sui/src/SuiHeader.gd | 2 +- sui/src/SuiIconButton.gd | 14 ++++- sui/src/SuiText.gd | 2 +- sui/src/SuiTypes.gd | 3 + 21 files changed, 260 insertions(+), 154 deletions(-) create mode 100644 docs/docs/reference/classes/_category_.json create mode 100644 docs/docs/reference/classes/baseclass.md create mode 100644 docs/docs/reference/classes/types.md create mode 100644 docs/docs/reference/elements/_category_.json create mode 100644 docs/docs/reference/elements/header.md create mode 100644 docs/docs/reference/elements/iconbutton.md create mode 100644 docs/docs/reference/elements/text.md rename docs/docs/reference/{ => elements}/textbutton.md (50%) delete mode 100644 docs/docs/reference/header.md delete mode 100644 docs/docs/reference/iconbutton.md delete mode 100644 docs/docs/reference/text.md diff --git a/docs/docs/about.md b/docs/docs/about.md index 989faa1..0b729e1 100644 --- a/docs/docs/about.md +++ b/docs/docs/about.md @@ -1,9 +1,9 @@ --- -sidebar_position: 1 +sidebar_position: 0 --- # About StarOpenSource UI -StarOpenSource UI (`sui` for short) is a collection of common ui elements for the [Godot Engine](https://godotengine.org). SUI requires the [CORE Framework](https://core.staropensource.de) to function. +StarOpenSource UI (`SUI` for short) is a collection of common ui elements for the [Godot Engine](https://godotengine.org). SUI requires the [CORE Framework](https://core.staropensource.de) to function. # Roadmap - [x] Text and Headings diff --git a/docs/docs/getting-started/_category_.json b/docs/docs/getting-started/_category_.json index 012a1e3..c96f668 100644 --- a/docs/docs/getting-started/_category_.json +++ b/docs/docs/getting-started/_category_.json @@ -1,6 +1,6 @@ { "label": "Getting started", - "position": 2, + "position": 1, "link": { "type": "generated-index", "description": "Helps you get SUI set up in your project." diff --git a/docs/docs/getting-started/setting-up.mdx b/docs/docs/getting-started/setting-up.mdx index bd50002..48595a7 100644 --- a/docs/docs/getting-started/setting-up.mdx +++ b/docs/docs/getting-started/setting-up.mdx @@ -18,6 +18,9 @@ It does not matter which framework branch you choose as StarOpenSource UI only u ::: ## Using git +:::note +You'll need to execute all commands in your project root. +::: ### Installing SUI diff --git a/docs/docs/reference/_category_.json b/docs/docs/reference/_category_.json index 231ce9c..f91651c 100644 --- a/docs/docs/reference/_category_.json +++ b/docs/docs/reference/_category_.json @@ -1,8 +1,8 @@ { "label": "Reference", - "position": 3, + "position": 2, "link": { "type": "generated-index", - "description": "UI element documentation" + "description": "StarOpenSource UI reference" } } diff --git a/docs/docs/reference/classes/_category_.json b/docs/docs/reference/classes/_category_.json new file mode 100644 index 0000000..e06af5a --- /dev/null +++ b/docs/docs/reference/classes/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Class reference", + "position": 0, + "link": { + "type": "generated-index", + "description": "Classes reference" + } +} diff --git a/docs/docs/reference/classes/baseclass.md b/docs/docs/reference/classes/baseclass.md new file mode 100644 index 0000000..714dbdd --- /dev/null +++ b/docs/docs/reference/classes/baseclass.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 1 +--- + +# `SuiBaseClass` +A template that can be used to build custom UI elements. + +## Variables +### *Core* core +Reference to the CORE Object. Set by `_ready()`. +### *CoreLoggerInstance* logger = *null* +Reference to a CoreLoggerInstance. Must be set manually. + +## Configuration +:::note +These are variables, we just labeled them differently. +::: +### *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* _ready() +Initializes the base class. \ +To run additional code in `_ready()`, use this example: +```gdscript +func _ready() -> void: + super() + # Your code here +``` +### *void* _process(*float* _delta) +Calls `update_element()` if allowed to execute. +### *void* update_element() +This method is intended to be extended by a child script. \ +Use this to implement your own element update logic. +### *bool* execute_process() +Determines if `_process()` is allowed to execute. +### *bool* in_editor() +Determines if running inside or outside the editor. \ No newline at end of file diff --git a/docs/docs/reference/classes/types.md b/docs/docs/reference/classes/types.md new file mode 100644 index 0000000..08a06b6 --- /dev/null +++ b/docs/docs/reference/classes/types.md @@ -0,0 +1,27 @@ +--- +sidebar_position: 0 +--- + +# `SuiTypes` +Defines various enums used throughout most user interface elements. + +## Enums +### ScrollVisiblity +Used for determining the visibility of scroll bars. +#### Avaiable values +- AUTO +- SHOWN +- HIDDEN +### ScrollMode +Used for determining how to get the result of various things. +#### Available values +- MULTIPLY_VIEWPORT +- MULTIPLY_CUSTOM_VALUE +- CUSTOM_VALUE +### ScrollDirection +Indicates some scrolling direction. +#### Available values +- UP +- DOWN +- LEFT +- RIGHT diff --git a/docs/docs/reference/elements/_category_.json b/docs/docs/reference/elements/_category_.json new file mode 100644 index 0000000..80500d2 --- /dev/null +++ b/docs/docs/reference/elements/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Elements reference", + "position": 1, + "link": { + "type": "generated-index", + "description": "UI elements reference" + } +} diff --git a/docs/docs/reference/elements/header.md b/docs/docs/reference/elements/header.md new file mode 100644 index 0000000..2abedb3 --- /dev/null +++ b/docs/docs/reference/elements/header.md @@ -0,0 +1,21 @@ +--- +sidebar_position: 0 +--- + +# `SuiHeader` + +## Variables +### *bool* bbcode_support = *true* +Enables support for BBCode. +### *String* text = *"[center]SuiHeader[/center]"* +The text you want to display. +### *int* font_size = *35* +The size your text should have. +### *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. diff --git a/docs/docs/reference/elements/iconbutton.md b/docs/docs/reference/elements/iconbutton.md new file mode 100644 index 0000000..49c227f --- /dev/null +++ b/docs/docs/reference/elements/iconbutton.md @@ -0,0 +1,57 @@ +--- +sidebar_position: 3 +--- + +# `SuiIconButton` + +## Signals +### down +- Signature: *none* +### up +- Signature: *none* +### pressed +- Signature: *none* +### toggled +- Signature: *bool* toggled_on + +## Variables +### *bool* disabled = *false* +Makes the button unable to be interacted with. +### *bool* toggle_mode = *false* +Makes the button toggleable. +### *bool* button_pressed = *false* +Forwarded from the internal `Button`. Will be overridden with the internal button's value, any changes to this variable will not be reflected. +### *Texture2D* image +The image you want to display. +### *Rect2D* region_rect = *Rect2(0, 0, 0, 0)* +See [NinePatchRect.region_rect](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-region-rect). +### *bool* draw_center = *true* +See [NinePatchRect.draw_center](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-draw-center). +### *int* ip_left = *0* +Icon padding (left side). +### *int* ip_top = *0* +Icon padding (top side). +### *int* ip_right = *0* +Icon padding (right side). +### *int* ip_bottom = *0* +Icon padding (bottom side). +### *int* pm_left = *0* +See [NinePatchRect.patch_margin_left](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-patch-margin-left). +### *int* pm_top = *0* +See [NinePatchRect.patch_margin_top](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-patch-margin-top). +### *int* pm_right = *0* +See [NinePatchRect.patch_margin_right](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-patch-margin-right). +### *int* pm_bottom = *0* +See [NinePatchRect.patch_margin_bottom](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-patch-margin-bottom). +### *NinePatchRect.AxisStretchMode* as_horizontal = *0* +See [NinePatchRect.axis_stretch_horizontal](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-axis-stretch-horizontal). +### *NinePatchRect.AxisStretchMode* as_vertical = *0* +See [NinePatchRect.axis_stretch_vertical](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-axis-stretch-vertical). +### *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. diff --git a/docs/docs/reference/elements/text.md b/docs/docs/reference/elements/text.md new file mode 100644 index 0000000..88b6349 --- /dev/null +++ b/docs/docs/reference/elements/text.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +# `SuiText` + +## Signals +### meta_clicked +- Signature: *Variant* meta + +Emitted when some interactive BBCode tag (e.g. url) is clicked +### meta_hover_started +- Signature: *Variant* meta + +Emitted when some interactive BBCode tag (e.g. url) is hovered over +### meta_hover_ended +- Signature: *Variant* meta + +Emitted when some interactive BBCode tag (e.g. url) is no longre being hovered over + +## Variables +### *bool* bbcode_support = *true* +Enables support for BBCode +### *String* text = *"[center]SuiText[/center]"* +The text you want to display. +### *int* font_size = *25* +The size your text should have. +### *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. diff --git a/docs/docs/reference/textbutton.md b/docs/docs/reference/elements/textbutton.md similarity index 50% rename from docs/docs/reference/textbutton.md rename to docs/docs/reference/elements/textbutton.md index 12006af..eb2a279 100644 --- a/docs/docs/reference/textbutton.md +++ b/docs/docs/reference/elements/textbutton.md @@ -1,35 +1,37 @@ --- -sidebar_position: 3 +sidebar_position: 2 --- # `SuiTextButton` -A button with text. ## Signals ### down +- Signature: *none* ### up +- Signature: *none* ### pressed +- Signature: *none* ### toggled - Signature: *bool* toggled_on ## Variables ### *bool* disabled = *false* -Disables the button. +Makes the button unable to be interacted with. ### *bool* toggle_mode = *false* Makes the button toggleable. ### *bool* button_pressed = *false* -Indicates if the button is pressed/toggled. Will be overwritten with the internal button's value, any manual changes to this variable will not be reflected. +Forwarded from the internal `Button`. Will be overridden with the internal button's value, any changes to this variable will not be reflected. ### *bool* bbcode_support = *true* -Enables or disables BBCode. +Enables support for BBCode. ### *String* text = *"[center]SuiTextButton[/center]"* -The text you want it to display. +The text you want to display. ### *int* font_size = *25* -The size of all text fonts. +The size your text should have. ### *bool* editor_process = *true* -Determines if the editor script should be executed every frame. +Determines if the element should be updated automatically **while running in the editor**. ### *bool* runtime_process = *true* -Determines if the runtime script should be executed every frame. `update_element()` needs to be called manually if `false`. +Determines if the element should be updated automatically **during your game/application's runtime**. ## Functions ### *void* update_element() -Updates all internal nodes. \ No newline at end of file +Updates the element. diff --git a/docs/docs/reference/header.md b/docs/docs/reference/header.md deleted file mode 100644 index 1328e16..0000000 --- a/docs/docs/reference/header.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -sidebar_position: 1 ---- - -# `SuiHeader` -Used for headings. - -## Variables -### *bool* bbcode_support = *true* -Enables or disables BBCode. -### *String* text = *"[center]SuiHeader[/center]"* -The text you want it to display. -### *int* font_size = *35* -The size of all text fonts. -### *bool* editor_process = *true* -Determines if the editor script should be executed every frame. -### *bool* runtime_process = *true* -Determines if the runtime script should be executed every frame. `update_element()` needs to be called manually if `false`. - -## Functions -### *void* update_element() -Updates all internal nodes. \ No newline at end of file diff --git a/docs/docs/reference/iconbutton.md b/docs/docs/reference/iconbutton.md deleted file mode 100644 index 452f1a3..0000000 --- a/docs/docs/reference/iconbutton.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_position: 4 ---- - -# `SuiIconButton` -A button with an image. - -## Signals -### down -### up -### pressed -### toggled -- Signature: *bool* toggled_on - -## Variables -### *bool* disabled = *false* -Disables the button. -### *bool* toggle_mode = *false* -Makes the button toggleable. -### *bool* button_pressed = *false* -Indicates if the button is pressed/toggled. Will be overwritten with the internal button's value, any manual changes to this variable will not be reflected. -### *Texture2D* image -The image you want to display. \ -Is unset in the script but is set to [Tux](https://en.wikipedia.org/wiki/Tux_(mascot)) in the scene file. -### *Rect2D* region_rect = *Rect2(0, 0, 0, 0)* -[View in the Godot documentation.](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-region-rect) -### *bool* draw_center = *true* -[View in the Godot documentation.](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-draw-center) -### *int* ip_left = *0* -The icon padding on the left side. \ -Is set to `0` in the script but is set to `5` in the scene file. -### *int* ip_top = *0* -The icon padding on the top side. \ -Is set to `0` in the script but is set to `5` in the scene file. -### *int* ip_right = *0* -The icon padding on the right side. \ -Is set to `0` in the script but is set to `5` in the scene file. -### *int* ip_bottom = *0* -The icon padding on the bottom side. \ -Is set to `0` in the script but is set to `5` in the scene file. -### *int* pm_left = *0* -[View in the Godot documentation.](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-patch-margin-left) -### *int* pm_top = *0* -[View in the Godot documentation.](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-patch-margin-top) -### *int* pm_right = *0* -[View in the Godot documentation.](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-patch-margin-right) -### *int* pm_bottom = *0* -[View in the Godot documentation.](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-patch-margin-bottom) -### *NinePatchRect.AxisStretchMode* as_horizontal = *0* -[View in the Godot documentation.](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-axis-stretch-horizontal) -### *NinePatchRect.AxisStretchMode* as_vertical = *0* -[View in the Godot documentation.](https://docs.godotengine.org/en/4.2/classes/class_ninepatchrect.html#class-ninepatchrect-property-axis-stretch-vertical) -### *bool* editor_process = *true* -Determines if the editor script should be executed every frame. -### *bool* runtime_process = *true* -Determines if the runtime script should be executed every frame. `update_element()` needs to be called manually if `false`. - -## Functions -### *void* update_element() -Updates all internal nodes. \ No newline at end of file diff --git a/docs/docs/reference/text.md b/docs/docs/reference/text.md deleted file mode 100644 index fdb6da8..0000000 --- a/docs/docs/reference/text.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -sidebar_position: 2 ---- - -# `SuiText` -Used for texts. - -## Signals -### meta_clicked -- Signature: *Variant* meta -### meta_hover_started -- Signature: *Variant* meta -### meta_hover_ended -- Signature: *Variant* meta - -## Variables -### *bool* bbcode_support = *true* -Enables or disables BBCode. -### *String* text = *"[center]SuiText[/center]"* -The text you want it to display. -### *int* font_size = *25* -The size of all text fonts. -### *bool* editor_process = *true* -Determines if the editor script should be executed every frame. -### *bool* runtime_process = *true* -Determines if the runtime script should be executed every frame. `update_element()` needs to be called manually if `false`. - -## Functions -### *void* update_element() -Updates all internal nodes. \ No newline at end of file diff --git a/docs/package.json b/docs/package.json index cd36bf7..230d460 100644 --- a/docs/package.json +++ b/docs/package.json @@ -15,22 +15,22 @@ "typecheck": "tsc" }, "dependencies": { - "@docusaurus/core": "3.1.1", - "@docusaurus/plugin-client-redirects": "^3.1.1", - "@docusaurus/plugin-content-docs": "^3.1.1", - "@docusaurus/plugin-sitemap": "^3.1.1", - "@docusaurus/preset-classic": "3.1.1", - "@mdx-js/react": "^3.0.0", - "clsx": "^2.0.0", - "prism-react-renderer": "^2.3.0", - "react": "^18.0.0", - "react-dom": "^18.0.0" + "@docusaurus/core": "3.3.2", + "@docusaurus/plugin-client-redirects": "^3.3.2", + "@docusaurus/plugin-content-docs": "^3.3.2", + "@docusaurus/plugin-sitemap": "^3.3.2", + "@docusaurus/preset-classic": "3.3.2", + "@mdx-js/react": "^3.0.1", + "clsx": "^2.1.1", + "prism-react-renderer": "^2.3.1", + "react": "^18.3.1", + "react-dom": "^18.3.1" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.1.1", - "@docusaurus/tsconfig": "3.1.1", - "@docusaurus/types": "3.1.1", - "@types/node": "^20.11.0", + "@docusaurus/module-type-aliases": "3.3.2", + "@docusaurus/tsconfig": "3.3.2", + "@docusaurus/types": "3.3.2", + "@types/node": "^20.12.11", "typescript": "~5.2.2" }, "browserslist": { diff --git a/sui/src/SuiBaseClass.gd b/sui/src/SuiBaseClass.gd index 9aef9c3..9f74d32 100644 --- a/sui/src/SuiBaseClass.gd +++ b/sui/src/SuiBaseClass.gd @@ -2,9 +2,9 @@ extends Control class_name SuiBaseClass -## Reference to the [CORE] Object. +## Reference to the [CORE] Object. Set by [method _ready]. var core: Core -## Reference to a [CoreLoggerInstance] +## Reference to a [CoreLoggerInstance]. Must be set manually. var logger: CoreLoggerInstance = null @export_category("Debugging") @@ -14,26 +14,32 @@ var logger: CoreLoggerInstance = null @export var runtime_process: bool = true # +++ initialization and process methods +++ -# Initializes the base class +## Initializes the base class.[br] +## To run additional code in `_ready()`, use this example: +## [/codeblock] +## func _ready() -> void: +## super() +## # Your code here +## [/codeblock] func _ready() -> void: if !in_editor(): core = get_node("/root/CORE") -# Calls 'update_element()' if allowed to execute +## Calls [method update_element] if allowed to execute func _process(_delta: float): if execute_process(): update_element() # +++ element updating +++ -# This should be used by the element extending this script -# to provide their own update logic. +## This method is intended to be extended by a child script.[br] +## Use this to implement your own element update logic. func update_element() -> void: pass # +++ etc +++ -# Determines if '_process()' is allowed to execute +## Determines if [method _process] is allowed to execute- func execute_process() -> bool: if in_editor() and !editor_process: return false elif !in_editor() and !runtime_process: return false else: return true -# Determines if running inside the editor +## Determines if running inside or outside the editor- func in_editor() -> bool: return get_node_or_null("/root/CORE") == null diff --git a/sui/src/SuiHeader.gd b/sui/src/SuiHeader.gd index 23363c9..6830651 100644 --- a/sui/src/SuiHeader.gd +++ b/sui/src/SuiHeader.gd @@ -7,7 +7,7 @@ extends SuiBaseClass @export var bbcode_support: bool = true ## The text you want to display. @export_multiline var text: String = "[center]SuiHeader[/center]" -## The size your font should have. +## The size your text should have. @export var font_size: int = 35 func update_element() -> void: diff --git a/sui/src/SuiIconButton.gd b/sui/src/SuiIconButton.gd index 06b6d9d..2649443 100644 --- a/sui/src/SuiIconButton.gd +++ b/sui/src/SuiIconButton.gd @@ -7,25 +7,33 @@ extends SuiBaseClass @export var disabled: bool = false ## Makes the button toggleable. @export var toggle_mode: bool = false -## Forwarded from the internal [Button]. Will be overwritten with the internal button's value, any manual changes to this variable will not be reflected. +## Forwarded from the internal [Button]. Will be overriden with the internal button's value, any changes to this variable will not be reflected. @export var button_pressed: bool = false @export_subgroup("Icon") ## The image you want to display. @export var image: Texture2D -## See [member NinePatchRect.region_rect] +## See [member NinePatchRect.region_rect]. @export var region_rect: Rect2 = Rect2(0, 0, 0, 0) -## See [member NinePatchRect.draw_center] +## See [member NinePatchRect.draw_center]. @export var draw_center: bool = true @export_category("Advanced Configuration") @export_subgroup("Icon Padding") +## Icon padding (left side) @export var ip_left: int = 0 +## Icon padding (top side) @export var ip_top: int = 0 +## Icon padding (right side) @export var ip_right: int = 0 +## Icon padding (bottom side) @export var ip_bottom: int = 0 @export_subgroup("Patch Margin") +## See [member NinePatchRect.patch_margin_left]. @export var pm_left: int = 0 +## See [member NinePatchRect.patch_margin_top]. @export var pm_top: int = 0 +## See [member NinePatchRect.patch_margin_right]. @export var pm_right: int = 0 +## See [member NinePatchRect.patch_margin_bottom]. @export var pm_bottom: int = 0 @export_subgroup("Axis Stretch") ## See [member NinePathRect.axis_stretch_horizontal]. diff --git a/sui/src/SuiText.gd b/sui/src/SuiText.gd index 63e0f67..91bcda4 100644 --- a/sui/src/SuiText.gd +++ b/sui/src/SuiText.gd @@ -7,7 +7,7 @@ extends SuiBaseClass @export var bbcode_support: bool = true ## The text you want to display. @export_multiline var text: String = "[center]SuiText[/center]" -## The size your font should have. +## The size your text should have. @export var font_size: int = 25 ## Emitted when some interactive BBCode tag (e.g. url) is clicked diff --git a/sui/src/SuiTypes.gd b/sui/src/SuiTypes.gd index 1628a64..7642980 100644 --- a/sui/src/SuiTypes.gd +++ b/sui/src/SuiTypes.gd @@ -1,16 +1,19 @@ extends Node class_name SuiTypes +## Used for determining the visibility of scroll bars. enum ScrollVisibility { AUTO, SHOWN, HIDDEN } +## Used for determining how to get the result of various things. enum ScrollMode { MULTIPLY_VIEWPORT, MULTIPLY_CUSTOM_VALUE, CUSTOM_VALUE } +## Indicates some scrolling direction. enum ScrollDirection { UP, DOWN,