WoW API: CheckInteractDistance

From AddOn Studio
Revision as of 04:45, 15 August 2023 by Move page script (talk | contribs) (Move page script moved page API CheckInteractDistance to API CheckInteractDistance without leaving a redirect)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

WoW API < CheckInteractDistance

Checks whether you are in range to perform a specific interaction with a specified unit.

inRange = CheckInteractDistance("unit", distIndex);

Arguments[edit]

unit
String - Unit to compare distance to.
distIndex
Number - A value from 1 to 4:
1 = Inspect, 28 yards
2 = Trade, 11.11 yards
3 = Duel, 9.9 yards
4 = Follow, 28 yards

Returns[edit]

inRange
Boolean flag - 1 if you are in range to perform the interaction, nil otherwise.

Example[edit]

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

Notes[edit]

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