GitHub/Basalt
1
0
Fork 0
Code Issues 28 Pull Requests 3 Actions Packages Projects Releases 9 Wiki Activity

updated docs

Browse Source
This commit is contained in:
Samkist
2022-05-30 02:23:40 -04:00
parent 2a8817df96
commit e5bc39a6f7
51 changed files with 1673 additions and 3347 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
docs/objects/Slider.md
View File

@@ -1,42 +1,42 @@
# Slider
With sliders you can add a object where the user can change a number value.<br><br>
Here are all possible functions available for sliders: <br>
Remember slider also inherits from [object](/objects/Object)
## setSymbol
this will change the foreground symbol
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aSlider = mainFrame:addSlider("myFirstSlider"):setSymbol("X"):show()
````
**parameters:** char symbol<br>
**returns:** self<br>
## setBackgroundSymbol
this will change the symbol background color
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aSlider = mainFrame:addSlider("myFirstSlider"):setBackgroundSymbol(colors.yellow):show()
````
**parameters:** number color<br>
**returns:** self<br>
## setSymbolColor
this will change the symbol color
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aSlider = mainFrame:addSlider("myFirstSlider"):setSymbolColor(colors.red):show()
````
**parameters:** number color<br>
**returns:** self<br>
## setBarType
this will change the bar to vertical/horizontal (default is horizontal)
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aSlider = mainFrame:addSlider("myFirstSlider"):setBarType("vertical"):show()
````
**parameters:** string value ("vertical", "horizontal"<br>
**returns:** self<br>
With sliders you can add a object where the user can change a number value.<br><br>
Here are all possible functions available for sliders: <br>
Remember slider also inherits from [object](https://github.com/NoryiE/Basalt/wiki/Object)
## setSymbol
this will change the foreground symbol
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aSlider = mainFrame:addSlider("myFirstSlider"):setSymbol("X"):show()
````
**parameters:** char symbol<br>
**returns:** self<br>
## setBackgroundSymbol
this will change the symbol background color
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aSlider = mainFrame:addSlider("myFirstSlider"):setBackgroundSymbol(colors.yellow):show()
````
**parameters:** number color<br>
**returns:** self<br>
## setSymbolColor
this will change the symbol color
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aSlider = mainFrame:addSlider("myFirstSlider"):setSymbolColor(colors.red):show()
````
**parameters:** number color<br>
**returns:** self<br>
## setBarType
this will change the bar to vertical/horizontal (default is horizontal)
````lua
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aSlider = mainFrame:addSlider("myFirstSlider"):setBarType("vertical"):show()
````
**parameters:** string value ("vertical", "horizontal"<br>
**returns:** self<br>