79 lines
2.3 KiB
Markdown
79 lines
2.3 KiB
Markdown
# Slider
|
|
_This is the slider class. It provides a draggable slider control that can be either horizontal or vertical,_
|
|
_with customizable colors and value ranges._
|
|
|
|
Extends: `VisualElement`
|
|
|
|
## Properties
|
|
|
|
|Property|Type|Default|Description|
|
|
|---|---|---|---|
|
|
|step|number|1|Current position of the slider handle (1 to width/height)|
|
|
|max|number|100|Maximum value for value conversion (maps slider position to this range)|
|
|
|horizontal|boolean|true|Whether the slider is horizontal (false for vertical)|
|
|
|barColor|color|gray|Color of the slider track|
|
|
|sliderColor|color|blue|Color of the slider handle|
|
|
|
|
## Events
|
|
|
|
|Event|Parameters|Description|
|
|
|---|---|---|
|
|
|onChange|`value number`|Fired when the slider value changes|
|
|
|
|
## Functions
|
|
|
|
|Method|Returns|Description|
|
|
|---|---|---|
|
|
|[Slider.new](#slider-new)|Slider|Creates a new Slider instance|
|
|
|[Slider:init](#slider-init-props-basalt)|Slider|Initializes the Slider instance|
|
|
|[Slider:getValue](#slider-getvalue)|number|Gets the current value mapped to the max range|
|
|
|[Slider:mouse_click](#slider-mouse-click-button-x-y)|boolean|Updates slider position on mouse click|
|
|
|[Slider:mouse_scroll](#slider-mouse-scroll-button-x-y)|boolean|Handles mouse release events|
|
|
|[Slider:render](#slider-render)|-|Renders the slider with track and handle|
|
|
|
|
## Slider.new()
|
|
|
|
Creates a new Slider instance
|
|
|
|
### Returns
|
|
* `Slider` `self` The newly created Slider instance
|
|
|
|
## Slider:init(props, basalt)
|
|
### Parameters
|
|
* `props` `table` The properties to initialize the element with
|
|
* `basalt` `table` The basalt instance
|
|
|
|
### Returns
|
|
* `Slider` `self` The initialized instance
|
|
|
|
## Slider:getValue()
|
|
|
|
Gets the current value of the slider
|
|
|
|
### Returns
|
|
* `number` `value` The current value (0 to max)
|
|
|
|
### Usage
|
|
```lua
|
|
local value = slider:getValue()
|
|
```
|
|
|
|
## Slider:mouse_click(button, x, y)
|
|
### Parameters
|
|
* `button` `number` The mouse button that was clicked
|
|
* `x` `number` The x position of the click
|
|
* `y` `number` The y position of the click
|
|
|
|
### Returns
|
|
* `boolean` `handled` Whether the event was handled
|
|
|
|
## Slider:mouse_scroll(button, x, y)
|
|
### Parameters
|
|
* `button` `number` The mouse button that was released
|
|
* `x` `number` The x position of the release
|
|
* `y` `number` The y position of the release
|
|
|
|
### Returns
|
|
* `boolean` `handled` Whether the event was handled
|
|
|
|
## Slider:render() |