From cf42f6f506a901d41875d64d52360e996c0d62c5 Mon Sep 17 00:00:00 2001 From: Robert Jelic <36573031+NoryiE@users.noreply.github.com> Date: Mon, 2 May 2022 22:13:37 +0200 Subject: [PATCH] Updated Scrollbar (markdown) --- Scrollbar.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/Scrollbar.md b/Scrollbar.md index 531071d..52e03fe 100644 --- a/Scrollbar.md +++ b/Scrollbar.md @@ -2,50 +2,50 @@ Scrollbars are objects, the user can scroll vertically or horizontally, this can Here is a example of how to create a standard scrollbar: ````lua -local mainFrame = NyoUI.createFrame("myFirstFrame"):show() +local mainFrame = basalt.createFrame("myFirstFrame"):show() local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):show() ```` This will create a default label with a size 5 width and 1 height on position 1 1 (relative to its parent frame), the default background is colors.gray, the default text color is colors.black. the default bar type is vertical, the default symbol is " " and the default symbol color is colors.lightGray. The default zIndex is 5. -Here are all possible functions available for scrollbars. Remember scrollbar inherit from [object](https://github.com/NoryiE/NyoUI/wiki/Object): +Here are all possible functions available for scrollbars. Remember scrollbar inherit from [object](https://github.com/NoryiE/Basalt/wiki/Object): ## setSymbol Changes the symbol ````lua -local mainFrame = NyoUI.createFrame("myFirstFrame"):show() +local mainFrame = basalt.createFrame("myFirstFrame"):show() local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):setSymbol("X"):show() ```` -**args:** char
-**returns:** the object
+**parameters:** char symbol
+**returns:** self
-## setSymbolColor -Changes the symbol color +## setBackgroundSymbol +Changes the background symbol color ````lua -local mainFrame = NyoUI.createFrame("myFirstFrame"):show() -local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):setSymbol("X"):setSymbolColor(colors.green):show() +local mainFrame = basalt.createFrame("myFirstFrame"):show() +local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):setSymbol("X"):setBackgroundSymbol(colors.green):show() ```` -**args:** color
-**returns:** the object
+**parameters:** number symbolcolor
+**returns:** self
## setBarType If the bar goes vertically or horizontally ````lua -local mainFrame = NyoUI.createFrame("myFirstFrame"):show() +local mainFrame = basalt.createFrame("myFirstFrame"):show() local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):setBarType("horizontal"):show() ```` -**args:** "vertical" or "horizontal"
-**returns:** the object
+**parameters:** string value ("vertical" or "horizontal")
+**returns:** self
## setMaxValue the default max value is always the width (if vertical) or height (if horizontal), if you change the max value the bar will always calculate the value based of his width or height - example: you set the max value to 100, the height is 10 and it is a vertical bar, this means if the bar is on top, the value is 10, if the bar goes one below, it is 20 and so on. ````lua -local mainFrame = NyoUI.createFrame("myFirstFrame"):show() +local mainFrame = basalt.createFrame("myFirstFrame"):show() local aScrollbar = mainFrame:addScrollbar("myFirstScrollbar"):setMaxValue(123):show() ```` -**args:** any number
-**returns:** the object
+**parameters:** any number
+**returns:** self