Toggle

A toggle flips a boolean. CreateSwitch is an alias for the same element.

local sprint = tab:CreateToggle({
    name = "Auto Sprint",
    flag = "AutoSprint",
    value = true,
    callback = function(value)
        print("Auto Sprint:", value)
    end,
})

sprint:Set(false)

Properties

string

The label.

string

Hint text under the label. Optional.

string | number

An icon shown beside the label. Optional.

boolean

default:"false"

The initial state.

string

default:"derived from name"

The save key. Optional.

boolean

default:"false"

Skip saving.

function

Runs with the new value on every change.

Handle

boolean

The current state.

Set the state. Pass true as the second argument to skip the callback.

Get started

Elements

Feedback

Configuration

Security

Properties

Handle

​Properties

​Handle

Properties

Handle