Datatype · Userdata

GuiSlider

userdata

Slider proxy returned by GuiCategory:add_slider. Backed by SliderInt or SliderFloat depending on the kind passed to add_slider.

Fields

NameTypeDescription
categoryGuiCategory?

Back-reference to the owning category. nil after the owning tab is gone.

destroy() -> ()

Marks the slider destroyed.

get_number() -> number

Returns the current slider value.

is_destroyed() -> boolean

Returns the destroyed flag.

is_visible() -> boolean

Returns the visibility flag.

kindControlKind

Either Enum.ControlKind.SliderInt or Enum.ControlKind.SliderFloat.

labelstring

Current label text.

namestring

Alias for label.

on_changed(callback: (value: number) -> ()) -> GuiConnection

Registers an additional change listener.

set_label(text: string) -> ()

Replaces the label.

set_number(value: number) -> ()

Writes the slider value.

set_postfix(postfix: string) -> ()

Sets the literal text rendered immediately after the slider's numeric value, inside the drag area.

set_prefix(prefix: string) -> ()

Sets the literal text rendered immediately before the slider's numeric value, inside the drag area.

set_visible(visible: boolean) -> ()

Shows or hides the slider.