Basalt 1.7 Update
- 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
This commit is contained in:
Robert Jelic
@@ -1,5 +1,29 @@
|
||||
## getIndex
|
||||
Returns the current index
|
||||
|
||||
#### Returns:
|
||||
### Description
|
||||
|
||||
Returns the current index of the Slider object.
|
||||
|
||||
### Returns
|
||||
|
||||
1. `number` index
|
||||
|
||||
### Usage
|
||||
|
||||
* Creates a new slider and prints the current index:
|
||||
|
||||
```lua
|
||||
local basalt = require("basalt")
|
||||
|
||||
local mainFrame = basalt.createFrame()
|
||||
local slider = mainFrame:addSlider()
|
||||
:setPosition(3, 3)
|
||||
:setSize(1, 10)
|
||||
:setMaxValue(20)
|
||||
|
||||
basalt.debug(slider:getIndex())
|
||||
|
||||
basalt.autoUpdate()
|
||||
```
|
||||
|
||||
In this example, a Slider object is created and added to the mainFrame. The getPosition, setSize, and setMaxValue methods are used to adjust the position, size, and maximum value of the Slider. The current index of the slider is then printed using the basalt.debug function.
|
||||
|
||||
@@ -1,18 +1,35 @@
|
||||
## setBackgroundSymbol
|
||||
Changes the symbol in the background, default is "\140"
|
||||
|
||||
#### Parameters:
|
||||
### Description
|
||||
|
||||
Changes the symbol in the background of the Slider object. The default symbol is "\140".
|
||||
|
||||
### Parameters
|
||||
|
||||
1. `string` symbol
|
||||
|
||||
#### Returns:
|
||||
### Returns
|
||||
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
### Usage
|
||||
|
||||
* Creates a new slider and changes the background symbol to X
|
||||
|
||||
```lua
|
||||
local basalt = require("basalt")
|
||||
|
||||
local mainFrame = basalt.createFrame()
|
||||
local slider = mainFrame:addSlider():setBackgroundSymbol("X")
|
||||
local slider = mainFrame:addSlider()
|
||||
:setPosition(3, 3)
|
||||
:setSize(1, 10)
|
||||
:setBackgroundSymbol("X")
|
||||
|
||||
basalt.autoUpdate()
|
||||
```
|
||||
|
||||
In this example, a Slider object is created and added to the mainFrame. The getPosition, setSize, and setBackgroundSymbol methods are used to adjust the position, size, and background symbol of the Slider. The slider's background symbol is set to "X".
|
||||
|
||||
```xml
|
||||
<slider backgroundSymbol="X" />
|
||||
```
|
||||
```
|
||||
|
||||
@@ -1,18 +1,35 @@
|
||||
## setBarType
|
||||
Changes the slider to be vertical or horizontal, default is horizontal
|
||||
|
||||
#### Parameters:
|
||||
1. `string` vertical or horizontal
|
||||
### Description
|
||||
|
||||
Changes the slider to be vertical or horizontal. The default is horizontal.
|
||||
|
||||
### Parameters
|
||||
|
||||
1. `string` "vertical" or "horizontal"
|
||||
|
||||
### Returns
|
||||
|
||||
#### Returns:
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a new slider and changes the bar type to horizontal
|
||||
### Usage
|
||||
|
||||
* Creates a new slider and changes the bar type to vertical:
|
||||
|
||||
```lua
|
||||
local basalt = require("basalt")
|
||||
|
||||
local mainFrame = basalt.createFrame()
|
||||
local slider = mainFrame:addSlider():setBarType("vertical")
|
||||
local slider = mainFrame:addSlider()
|
||||
:setPosition(3, 3)
|
||||
:setSize(1, 10)
|
||||
:setBarType("vertical")
|
||||
|
||||
basalt.autoUpdate()
|
||||
```
|
||||
|
||||
In this example, a Slider object is created and added to the mainFrame. The getPosition, setSize, and setBarType methods are used to adjust the position, size, and orientation of the Slider. The slider's orientation is set to "vertical".
|
||||
|
||||
```xml
|
||||
<slider barType="vertical" />
|
||||
```
|
||||
```
|
||||
|
||||
@@ -1,21 +1,42 @@
|
||||
## 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:
|
||||
### Description
|
||||
|
||||
Changes the current index of the slider 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:
|
||||
### 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
|
||||
### Usage
|
||||
|
||||
* Creates a new slider and changes the index to 1 as soon as the button got clicked:
|
||||
|
||||
```lua
|
||||
local basalt = require("basalt")
|
||||
|
||||
local mainFrame = basalt.createFrame()
|
||||
local slider = mainFrame:addSlider():setMaxValue(20)
|
||||
local button = mainFrame:addButton(function()
|
||||
slider:setIndex(1)
|
||||
end)
|
||||
local slider = mainFrame:addSlider()
|
||||
:setPosition(3, 3)
|
||||
:setSize(1, 10)
|
||||
:setMaxValue(20)
|
||||
|
||||
local button = mainFrame:addButton()
|
||||
:setPosition(3, 14)
|
||||
:setText("Set to 1")
|
||||
:onClick(function()
|
||||
slider:setIndex(1)
|
||||
end)
|
||||
|
||||
basalt.autoUpdate()
|
||||
```
|
||||
|
||||
In this example, a Slider object is created and added to the mainFrame. The getPosition, setSize, and setMaxValue methods are used to adjust the position, size, and maximum value of the Slider. A button is added to the mainFrame to change the index of the Slider to 1 when clicked.
|
||||
|
||||
```xml
|
||||
<slider index="2" />
|
||||
```
|
||||
```
|
||||
|
||||
@@ -1,18 +1,35 @@
|
||||
## 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:
|
||||
### Description
|
||||
|
||||
The default maximum 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. For example, if 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:
|
||||
### Returns
|
||||
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a new slider and changes the max value to 20
|
||||
### Usage
|
||||
|
||||
* Creates a new slider and changes the max value to 20:
|
||||
|
||||
```lua
|
||||
local basalt = require("basalt")
|
||||
|
||||
local mainFrame = basalt.createFrame()
|
||||
local slider = mainFrame:addSlider():setMaxValue(20)
|
||||
local slider = mainFrame:addSlider()
|
||||
:setPosition(3, 3)
|
||||
:setSize(1, 10)
|
||||
:setMaxValue(20)
|
||||
|
||||
basalt.autoUpdate()
|
||||
```
|
||||
|
||||
In this example, a Slider object is created and added to the mainFrame. The getPosition, setSize, and setMaxValue methods are used to adjust the position, size, and maximum value of the Slider. The slider's maximum value is set to 20.
|
||||
|
||||
```xml
|
||||
<slider maxValue="20" />
|
||||
```
|
||||
```
|
||||
|
||||
@@ -1,18 +1,35 @@
|
||||
## setSymbol
|
||||
Changes the slider symbol, default is " "
|
||||
|
||||
#### Parameters:
|
||||
### Description
|
||||
|
||||
Changes the slider symbol. The default symbol is a space " ".
|
||||
|
||||
### Parameters
|
||||
|
||||
1. `string` symbol
|
||||
|
||||
#### Returns:
|
||||
### Returns
|
||||
|
||||
1. `object` The object in use
|
||||
|
||||
#### Usage:
|
||||
* Creates a new slider and changes the symbol to X
|
||||
### Usage
|
||||
|
||||
* Creates a new slider and changes the symbol to "X":
|
||||
|
||||
```lua
|
||||
local basalt = require("basalt")
|
||||
|
||||
local mainFrame = basalt.createFrame()
|
||||
local slider = mainFrame:addSlider():setSymbol("X")
|
||||
local slider = mainFrame:addSlider()
|
||||
:setPosition(3, 3)
|
||||
:setSize(1, 10)
|
||||
:setSymbol("X")
|
||||
|
||||
basalt.autoUpdate()
|
||||
```
|
||||
|
||||
In this example, a Slider object is created and added to the mainFrame. The getPosition, setSize, and setSymbol methods are used to adjust the position, size, and symbol of the Slider. The slider's symbol is set to "X".
|
||||
|
||||
```xml
|
||||
<slider symbol="X" />
|
||||
```
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user