WoW:API CheckButton GetChecked: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
({{widgetmethod}})
m (Move page script moved page API CheckButton GetChecked to WoW:API CheckButton GetChecked without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{widgetmethod}}
{{widgetmethod}}
{{stub/api}}


Returns the current state of the button. Will return nil if the button is unchecked, or 1 if the button is checked.
Returns the current checked state of the button.  
isChecked = CheckButton:GetChecked()
 
== Arguments ==
:none
 
== Returns ==
:; isChecked :{{api|boolean|t=t}} - 'true' if the button state is checked. Default is 'false'.
 
== Notes ==
* As of 6.0.2, return value type was changed to the Lua native {{api|boolean|t=t}} type, instead of a WoW Flag style {{api|Boolean|t=t}} (1 for a checked button, nil otherwise).
 
== See also ==
* {{api|CheckButton:SetChecked|t=w}}

Latest revision as of 04:45, 15 August 2023

Widget API ← CheckButton < GetChecked

Returns the current checked state of the button.

isChecked = CheckButton:GetChecked()

Arguments

none

Returns

isChecked
boolean - 'true' if the button state is checked. Default is 'false'.

Notes

  • As of 6.0.2, return value type was changed to the Lua native boolean type, instead of a WoW Flag style Boolean (1 for a checked button, nil otherwise).

See also