WoW:API GetAutoLootDefault: Difference between revisions

Revision as of 14:46, 3 November 2008

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

As of 3.0, this function no longer exists. Use GetCVar("autoLootDefault") instead.

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
-<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
-Returns the state of Auto Loot.
-== Returns ==
+''As of 3.0, this function no longer exists. Use [[API GetCVar|GetCVar("autoLootDefault")]] instead.''
-<!-- List each return value, together with its type -->
-:;1 : integer - if Auto Loot is enabled (checked).
-:;nil : integer - if Auto Loot is disabled (unchecked).
-== Example ==
-<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
-''This toggles Auto Loot on and off when used in a macro spot.''
-:/script SetCVar("scriptErrors",1); if (GetAutoLootDefault()) then SetAutoLootDefault(false); message("Auto Loot is off."); else SetAutoLootDefault(true); message("Auto Loot is on."); end;
-or (easier to change if the need arises)
-:/script SetCVar("scriptErrors",1); local onOff = {["1"] = "on",["nil"] = "off"}; SetAutoLootDefault(not GetAutoLootDefault()); message("Auto Loot is "..onOff[tostring(GetAutoLootDefault())]..".");
-<big>'''Result'''</big>
-:Pops up a window informing the user of the state of Auto Loot. Very useful for toggling Auto Loot on the fly.