Widget API: CheckButton:SetChecked

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ Methods

← Widget API ← CheckButton < SetChecked

Sets the checked status of a CheckButton frame.

CheckButton:SetChecked(State);

Parameters

Arguments

state

boolean - 'true' sets the button state to checked. Default is 'false'.

Returns

none

Examples

CheckButton:SetChecked(true)

Button is checked

CheckButton:SetChecked(false)
CheckButton:SetChecked(0)
CheckButton:SetChecked(nil)
CheckButton:SetChecked()
CheckButton:SetChecked({1,2,3})
CheckButton:SetChecked("true")

Button is unchecked

Notes

• Passing "nil" will uncheck the button, but passing *no* argument (although it should end up being nil for Lua) will enable it, also passing a table ({...}) will now check the button.
• As of WoW 6.0 both GetChecked() and SetChecked() use Lua boolean values only. Passing value other than Lua boolean 'true' is the same as passing 'false', and GetChecked() will only return true or false. Prior to 6.0.2 values such as true, 1, -2397, {1,2,3}, "foo" would all set state as checked. Values such as false, 0, nil would set state as not checked.

See also

• CheckButton:GetChecked