Skip to main content
Also has everything from ElementHandle. An on / off switch. Value is a boolean. Saved when created with a non-nil key.
Value typeboolean
Created bySection:AddToggle

​
Creation

section:AddToggle(key: string?, label: string, default: boolean?): ToggleHandle

​
SetState

toggle:SetState(value: boolean): ()
Same as SetValue(value).

​
Toggle

toggle:Toggle(): ()
Flip the current value and fire OnChange.

​
Example

local enabled = section:AddToggle("enabled", "Enabled", false)

enabled:OnChange(function(on)
    print("enabled:", on)
end)

enabled:Toggle()
print(enabled:GetValue()) -- flipped