WoW:API UnitIsAFK: Difference between revisions

Latest revision as of 04:47, 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

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: @@
-{{Stub/API}}
+{{wowapi}} __NOTOC__
-{{wowapi}}
+Checks if a unit is AFK.
-== Parameters ==
+ isAFK = UnitIsAFK("unit")
 === Arguments ===
+;unit : The [[UnitId]] to return AFK status of.
-:;unitName : The [[API TYPE UnitId|Unit id]] you want debuff information for.
 === Returns ===
+; isAFK
-:;afk
+: true if unit is AFK, false otherwise.
 == Example ==
+If the player is AFK, the following script outputs "You are AFK" to the default chat window.
-<pre> afk = UnitIsAFK("player"); </pre>
+ if UnitIsAFK("player") then
+   DEFAULT_CHAT_FRAME:AddMessage("You are AFK");
-Checks if the player is AFK.
+ end