WoW:API CheckButton GetChecked: Difference between revisions

Latest revision as of 04:45, 15 August 2023

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

Returns the current checked state of the button.

isChecked = CheckButton:GetChecked()

none

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

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).

@@ Line 1: / Line 1: @@
-Returns the current state of the button. Will return nil if the button is unchecked, or 1 if the button is checked.
+{{widgetmethod}}
-{{API/Uncategorized}}
+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}}