CheckInteractDistance

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

Returns true if the player is in range to perform a specific interaction with the unit.

inRange = CheckInteractDistance(unit, distIndex)

Arguments

unit

string : UnitId - The unit to compare distance to.

distIndex

number - A value from 1 to 5:

1 = Compare Achievements, 28 yards

2 = Trade, 8 yards

3 = Duel, 7 yards

4 = Follow, 28 yards

5 = Pet-battle Duel, 7 yards

Returns

inRange

boolean - 1 if you are in range to perform the interaction, nil otherwise.

Details

• If "unit" is a hostile unit, the return values are the same. But you obviously won't be able to do things like Trade.

Example

if ( CheckInteractDistance("target", 4) ) then
  FollowUnit("target");
else
  -- we're too far away to follow the target
end

Patch changes

Hotfix (2023-12-11): Partially unrestricted. Querying enemy units while in combat is once again permitted. (Build: 10.2.0.52485)
Hotfix (2023-11-16): Protected. May no longer be called in combat by insecure code. (Build: 10.2.0.52188)