Docs 1.6
Accidentally uploaded outdated 1.6 docs
This commit is contained in:
14
docs/docs1_6/objects/Progressbar/getProgress.md
Normal file
14
docs/docs1_6/objects/Progressbar/getProgress.md
Normal file
@@ -0,0 +1,14 @@
|
||||
## getProgress
|
||||
Returns the current progress status
|
||||
|
||||
#### Returns:
|
||||
1. `number` progress (0-100)
|
||||
|
||||
#### Usage:
|
||||
* Creates a progressbar, sets the current progress to 50 and prints the current progress
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aProgressbar = mainFrame:addProgressbar()
|
||||
aProgressbar:setProgress(50)
|
||||
basalt.debug(aProgressbar:getProgress())
|
||||
```
|
||||
19
docs/docs1_6/objects/Progressbar/onDone.md
Normal file
19
docs/docs1_6/objects/Progressbar/onDone.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# onDone
|
||||
|
||||
`onDone(self, err)`<br>
|
||||
This is a custom event which gets triggered as soon as the progress is done.
|
||||
|
||||
Here is a example on how to add a onDone event to your progressbar:
|
||||
|
||||
```lua
|
||||
local basalt = require("basalt")
|
||||
|
||||
local main = basalt.createFrame()
|
||||
local aProgressbar = main:addProgressbar()
|
||||
|
||||
local function onProgressDone()
|
||||
basalt.debug("Progress is done")
|
||||
end
|
||||
|
||||
aProgressbar:onDone(onProgressDone)
|
||||
```
|
||||
19
docs/docs1_6/objects/Progressbar/setBackgroundSymbol.md
Normal file
19
docs/docs1_6/objects/Progressbar/setBackgroundSymbol.md
Normal file
@@ -0,0 +1,19 @@
|
||||
## setBackgroundSymbol
|
||||
This will change the background symbol (default is " " - space)
|
||||
|
||||
#### Parameters:
|
||||
1. `char` the background symbol
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a progressbar and sets the progressbar background symbol to X
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aProgressbar = mainFrame:addProgressbar()
|
||||
aProgressbar:setBackgroundSymbol("X")
|
||||
```
|
||||
```xml
|
||||
<progressbar backgroundSymbol="X" />
|
||||
```
|
||||
19
docs/docs1_6/objects/Progressbar/setDirection.md
Normal file
19
docs/docs1_6/objects/Progressbar/setDirection.md
Normal file
@@ -0,0 +1,19 @@
|
||||
## setDirection
|
||||
Sets the direction in which the bar should be expanding.
|
||||
|
||||
#### Parameters:
|
||||
1. `number` x direction (0 = left to right, 1 = top to bottom, 2 = right to left and 3 = bottom to top)
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a progressbar and sets the direction from bottom to top
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aProgressbar = mainFrame:addProgressbar()
|
||||
aProgressbar:setDirection(3)
|
||||
```
|
||||
```xml
|
||||
<frame direction="3"></frame>
|
||||
```
|
||||
16
docs/docs1_6/objects/Progressbar/setProgress.md
Normal file
16
docs/docs1_6/objects/Progressbar/setProgress.md
Normal file
@@ -0,0 +1,16 @@
|
||||
## setProgress
|
||||
This is the function you need to call if you want the progression to change.
|
||||
|
||||
#### Parameters:
|
||||
1. `number` a number from 0 to 100
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a progressbar and sets the current progress to 50
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aProgressbar = mainFrame:addProgressbar()
|
||||
aProgressbar:setProgress(50)
|
||||
```
|
||||
21
docs/docs1_6/objects/Progressbar/setProgressBar.md
Normal file
21
docs/docs1_6/objects/Progressbar/setProgressBar.md
Normal file
@@ -0,0 +1,21 @@
|
||||
## setProgressBar
|
||||
This function will change the visual display of your progress bar
|
||||
|
||||
#### Parameters:
|
||||
1. `number|color` the expanding progress bar color
|
||||
2. `char` optional - the bar symbol - default is " " (space)
|
||||
3. `number|color` optional - the bar symbol color
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a progressbar and sets the progressbar color to green
|
||||
```lua
|
||||
local mainFrame = basalt.createFrame()
|
||||
local aProgressbar = mainFrame:addProgressbar()
|
||||
aProgressbar:setProgressBar(colors.green, colors.yellow, colors.red)
|
||||
```
|
||||
```xml
|
||||
<progressbar progressColor="green" progressSymbol="yellow" progressSymbolColor="red" />
|
||||
```
|
||||
Reference in New Issue
Block a user