UnitIsAFK

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  wrath  vanilla
Links
Blizzard Docs  Townlong Yak  Offline /api  Wowprogramming  GitHub Search
Info
Added in 2.0.1 / 1.13.2

Returns true if a friendly unit is AFK (Away from keyboard).

isAFK = UnitIsAFK(unit)

Arguments

unit

The UnitId to return AFK status of. A nil value throws an error.

Returns

isAFK

boolean true if unit is AFK, Boolean false otherwise. An invalid or nonexistent unit value also returns false.

Example

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

History

Up until the WOD beta, the return value isAFK used to be 1 instead of true, and nil instead of false.