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

docs

Browse Source
This commit is contained in:
Robert Jelic
2022-07-18 16:45:59 +02:00
parent 8157c025ea
commit 9d10e95fae
10 changed files with 468 additions and 178 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/objects/Progressbar.md
View File

@@ -15,8 +15,8 @@ Sets the direction in which the bar should be expanding.
#### Usage:
* Creates a progressbar and sets the direction from bottom to top
```lua
local mainFrame = basalt.createFrame():show()
local aProgressbar = mainFrame:addProgressbar():show()
local mainFrame = basalt.createFrame()
local aProgressbar = mainFrame:addProgressbar()
aProgressbar:setDirection(3)
```
```xml
@@ -35,8 +35,8 @@ This is the function you need to call if you want the progression to change.
#### Usage:
* Creates a progressbar and sets the current progress to 50
```lua
local mainFrame = basalt.createFrame():show()
local aProgressbar = mainFrame:addProgressbar():show()
local mainFrame = basalt.createFrame()
local aProgressbar = mainFrame:addProgressbar()
aProgressbar:setProgress(50)
```
@@ -49,8 +49,8 @@ Returns the current progress status
#### Usage:
* Creates a progressbar, sets the current progress to 50 and prints the current progress
```lua
local mainFrame = basalt.createFrame():show()
local aProgressbar = mainFrame:addProgressbar():show()
local mainFrame = basalt.createFrame()
local aProgressbar = mainFrame:addProgressbar()
aProgressbar:setProgress(50)
basalt.debug(aProgressbar:getProgress())
```
@@ -69,8 +69,8 @@ This function will change the visual display of your progress bar
#### Usage:
* Creates a progressbar and sets the progressbar color to green
```lua
local mainFrame = basalt.createFrame():show()
local aProgressbar = mainFrame:addProgressbar():show()
local mainFrame = basalt.createFrame()
local aProgressbar = mainFrame:addProgressbar()
aProgressbar:setProgressBar(colors.green, colors.yellow, colors.red)
```
```xml
@@ -89,8 +89,8 @@ Will change the default background symbol (default is " " - space)
#### Usage:
* Creates a progressbar and sets the progressbar background symbol to X
```lua
local mainFrame = basalt.createFrame():show()
local aProgressbar = mainFrame:addProgressbar():show()
local mainFrame = basalt.createFrame()
local aProgressbar = mainFrame:addProgressbar()
aProgressbar:setBackgroundSymbol("X")
```
```xml
@@ -99,7 +99,7 @@ aProgressbar:setBackgroundSymbol("X")
# Events
# onProgressDone
## onProgressDone
`onProgressDone(self)`<br>
A custom event which gets triggered as soon as the progress reaches 100.
@@ -108,8 +108,8 @@ Here is a example on how to add a onProgressDone event to your progressbar:
```lua
local basalt = require("Basalt")
local mainFrame = basalt.createFrame():show()
local aProgressbar = mainFrame:addProgressbar():show()
local mainFrame = basalt.createFrame()
local aProgressbar = mainFrame:addProgressbar()
function progressDone()
basalt.debug("The Progressbar reached 100%!")