WoW:API UnitIsAFK: Difference between revisions

Revision as of 15:46, 11 July 2008

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

Checks if a unit is AFK.

isAFK = UnitIsAFK("unit")

If the player is AFK, the following script outputs "You are AFK" to the default chat window.

if UnitIsAFK("player") then
  DEFAULT_CHAT_FRAME:AddMessage("You are AFK");
end

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
 Checks if a unit is AFK.
-  isAFK = UnitIsAFK([[UnitId|unitId]])
+  isAFK = UnitIsAFK("unit")
 === Arguments ===
-:;unitId : The [[UnitId]] to check
+;unit : The [[UnitId]] to return AFK status of.
 === Returns ===
-:; isAFK : [[Boolean]] - Whether the unit is AFK
+; isAFK : 1 if unit is AFK, nil otherwise.
 == Example ==
-  afk = UnitIsAFK("player");
+If the player is AFK, the following script outputs "You are AFK" to the default chat window.
- if afk then
+  if UnitIsAFK("player") then
     DEFAULT_CHAT_FRAME:AddMessage("You are AFK");
   end
-<big>'''Results'''</big>
-If the player is AFK, it outputs "You are AFK" to the default chat window.