UnitDistanceSquared

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 6.0.2 / 1.13.2

Returns the squared distance to a unit in your group.

distanceSquared, checkedDistance = UnitDistanceSquared(unit)

Arguments

unit

string : UnitId - The unit id of a player in your group.

Returns

distanceSquared

number - the squared distance to that unit

checkedDistance

boolean - true if the distance result is valid, false otherwise (eg. unit not found or not in your group)

Patch changes

Patch 7.1.0 (2016-10-25): Returns nil while inside a restricted area (instance/battleground/arena).