bb1b1beb79
- New Objects (Flexbox, Graph, Treeview) - Pluginsystem to add/remove functionality - Reworked the entire Object system, instead of one big Object Class we have multiple classes: Object, VisualObject, ChangeableObject - Instead of one big Frame Class we have multiple Frame Classes: BaseFrame, Frame, MovableFrame, ScrollableFrame, MonitorFrame, Flexbox - Removed the Animation Object, and added a animation plugin instead - Removed the Graphic Object and merged it's functionality with the image object - Updated currently existing objects
109 lines
2.6 KiB
Markdown
109 lines
2.6 KiB
Markdown
Sliders are objects, the user can scroll vertically or horizontally, this will change a value, which you can access by :getValue().<br>
|
|
|
|
Remember slider also inherits from [Object](objects/Object.md)
|
|
|
|
## setSymbol
|
|
Changes the slider symbol, default is " "
|
|
|
|
#### Parameters:
|
|
1. `string` symbol
|
|
|
|
#### Returns:
|
|
1. `object` The object in use
|
|
|
|
#### Usage:
|
|
* Creates a new slider and changes the symbol to X
|
|
```lua
|
|
local mainFrame = basalt.createFrame()
|
|
local slider = mainFrame:addSlider():setSymbol("X")
|
|
```
|
|
```xml
|
|
<slider symbol="X" />
|
|
```
|
|
|
|
## setBackgroundSymbol
|
|
Changes the symbol in the background, default is "\140"
|
|
|
|
#### Parameters:
|
|
1. `string` symbol
|
|
|
|
#### Returns:
|
|
1. `object` The object in use
|
|
|
|
#### Usage:
|
|
* Creates a new slider and changes the background symbol to X
|
|
```lua
|
|
local mainFrame = basalt.createFrame()
|
|
local slider = mainFrame:addSlider():setBackgroundSymbol("X")
|
|
```
|
|
```xml
|
|
<slider backgroundSymbol="X" />
|
|
```
|
|
|
|
## setBarType
|
|
Changes the slider to be vertical or horizontal, default is horizontal
|
|
|
|
#### Parameters:
|
|
1. `string` vertical or horizontal
|
|
|
|
#### Returns:
|
|
1. `object` The object in use
|
|
|
|
#### Usage:
|
|
* Creates a new slider and changes the bar type to horizontal
|
|
```lua
|
|
local mainFrame = basalt.createFrame()
|
|
local slider = mainFrame:addSlider():setBarType("vertical")
|
|
```
|
|
```xml
|
|
<slider barType="vertical" />
|
|
```
|
|
|
|
## setMaxValue
|
|
the default max value is always the width (if horizontal) or height (if vertical), if you change the max value the bar will always calculate the value based on its 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.
|
|
|
|
#### Parameters:
|
|
1. `number` maximum
|
|
|
|
#### Returns:
|
|
1. `object` The object in use
|
|
|
|
#### Usage:
|
|
* Creates a new slider and changes the max value to 20
|
|
```lua
|
|
local mainFrame = basalt.createFrame()
|
|
local slider = mainFrame:addSlider():setMaxValue(20)
|
|
```
|
|
```xml
|
|
<slider maxValue="20" />
|
|
```
|
|
|
|
## setIndex
|
|
Changes the current index to your choice, for example you could create a button which scrolls up to 1 by using :setIndex(1)
|
|
|
|
#### Parameters:
|
|
1. `number` the index
|
|
|
|
#### Returns:
|
|
1. `object` The object in use
|
|
|
|
#### Usage:
|
|
* Creates a new slider and changes the index to 1 as soon as the button got clicked
|
|
```lua
|
|
local mainFrame = basalt.createFrame()
|
|
local slider = mainFrame:addSlider():setMaxValue(20)
|
|
local button = mainFrame:addButton(function()
|
|
slider:setIndex(1)
|
|
end)
|
|
```
|
|
```xml
|
|
<slider index="2" />
|
|
```
|
|
|
|
## getIndex
|
|
Returns the current index
|
|
|
|
#### Returns:
|
|
1. `number` index
|
|
|