Slider

Class Name: GNUI.Slider

an element that works as a slider.

Quick example on making a slider and doing something when the slider is moved around.

local GNUI = require"GNUI.main"
local Slider = require"GNUI.element.slider"
local screen = GNUI.getScreenCanvas()

local slider = Slider.new(screen)
---@type GNUI.InputEvent
slider.VALUE_CHANGED:register(function ()
  -- value changed
end)

Properties

Type	Field	Description
boolean	isVertical	...
number	max	...
number	min	...
GNUI.Box	numberBox	...
boolean	showNumber	...
GNUI.Box	sliderBox	...
number	step	...
number	value	...

Events

Event	Description
VALUE_CHANGED	...

Methods

Returns	Methods
GNUI.Slider	Slider.new(parent : GNUI.Box?, config : {isVertical: boolean?,min: number?,max: number?,step: number,value: number?,showNumber: boolean?}, variant : string｜"none"｜"default"?)
self	Slider:setValue(value : number)
self	Slider:setMin(min : number)
self	Slider:setMax(max : number)
self	Slider:setStep(step : number)
self	Slider:updateSliderBox()

Slider.new(parent, config, variant)

Arguments

• boolean isVertical

• {isVertical: boolean?,min: number?,max: number?,step: number,value: number?,showNumber: boolean?} config

• string|"none"|"default"? variant

Returns GNUI.Slider

Slider:setValue(value)

Sets the value of the slider.

Arguments

• number value

Returns self

Slider:setMin(min)

Sets the minimum value of the slider.

Arguments

• number min

Returns self

Slider:setMax(max)

Sets the maximum value of the slider.

Arguments

• number max

Returns self

Slider:setStep(step)

Sets the step size of the slider.

Arguments

• number step

Returns self

Slider:updateSliderBox()

Updates the displayed slider box.

Argument

Returns self