WoW:API UnitIsAFK: Difference between revisions

WoW:API UnitIsAFK (source)

173 bytes added , 25 June 2007

Updated to match the current API boilerplate.

Anonymous user

@@ Line 1: / Line 1: @@
-{{Stub/API}}
+{{wowapi}} __NOTOC__
-{{wowapi}}
-== Parameters ==
+Checks if a unit is AFK.
+ isAFK = UnitIsAFK([[UnitId|unitId]])
 === Arguments ===
+:;unitId : The [[UnitId]] to check
-:;unitName : The [[API TYPE UnitId|Unit id]] you want debuff information for.
 === Returns ===
+:; isAFK : [[Boolean]] - Whether the unit is AFK
-:;afk
 == Example ==
+ afk = UnitIsAFK("player");
+ if afk then
+   DEFAULT_CHAT_FRAME:AddMessage("You are AFK");
+ end
-<pre> afk = UnitIsAFK("player"); </pre>
+<big>'''Results'''</big>
-Checks if the player is AFK.
+If the player is AFK, it outputs "You are AFK" to the default chat window.