WoW:API CheckButton SetChecked: Difference between revisions

← Older edit

WoW:API CheckButton SetChecked (source)

Revision as of 04:45, 15 August 2023

210 bytes added , 15 August 2023

m

Move page script moved page API CheckButton SetChecked to WoW:API CheckButton SetChecked without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
 {{widgetmethod}} __NOTOC__
-Sets the status of a CheckButton.
+Sets the checked status of a CheckButton frame.
   CheckButton:SetChecked(State);
 == Parameters ==
 === Arguments ===
-:(State)
+:;state :{{api|boolean|t=t}} - 'true' sets the button state to checked. Default is 'false'.
-:;State : Mixed - Basically expressions LUA evaluates to '''true''' will check the button. Everything else will uncheck.
 === Returns ===
-:nil
+: none
-:;nil : This function will always return nil.
-----
-== Example ==
+== Examples ==
-  CheckButton:SetChecked(true);
+  CheckButton:SetChecked(true)
- CheckButton:SetChecked(1);
- CheckButton:SetChecked(-2397);
- CheckButton:SetChecked("-2397");
- CheckButton:SetChecked({1,2,3});
- CheckButton:SetChecked("foo");
- CheckButton:SetChecked();
-====Result====
 Button is checked
-== Example ==
+  CheckButton:SetChecked(false)
-  CheckButton:SetChecked(false);
+  CheckButton:SetChecked(0)
-  CheckButton:SetChecked(0);
+  CheckButton:SetChecked(nil)
-  CheckButton:SetChecked(nil);
+ CheckButton:SetChecked()
+ CheckButton:SetChecked({1,2,3})
+ CheckButton:SetChecked("true")
-====Result====
 Button is unchecked
-==Notes==
+== 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.
+* 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 {{api|boolean|t=t}} '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 ==
+* {{api|CheckButton:GetChecked|t=w}}