WoW:API CheckInteractDistance: Difference between revisions

WoW:API CheckInteractDistance (source)

Revision as of 00:00, 25 October 2009

105 bytes removed , 25 October 2009

boilerplate

Anonymous user

WoWWiki>Starlightblunder

@@ Line 1: / Line 1: @@
 {{wowapi}}
-Returns 1 if you are in range of the specified unit to perform the action specified by distIndex (returns nil otherwise).
+Checks whether you are in range to perform a specific interaction with a specified unit.
+ inRange = CheckInteractDistance("unit", distIndex);
-----
+==Arguments==
-;''Arguments''
+;unit : String - [[UnitId|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
-:(String unit, Int distIndex)
+==Returns==
+;inRange : Boolean flag - 1 if you are in range to perform the interaction, nil otherwise.
-:;unit : The unit to query (e.g. "target", "party1", "pet", "player")
+==Example==
-:;distIndex : A value 1-4:
-:::1 = Inspect, 28 yards
-:::2 = Trade, 11.11 yards
-:::3 = Duel, 9.9 yards
-:::4 = Follow, 28 yards
-----
-;''Returns''
-:;canInteract : If in range to perform the action, 1 (true).  Otherwise, nil (false).
-----
-;''Notes''
-:If "unit" is a hostile unit, the return values are the same.  But you obviously won't be able to do things like Trade.
-:There may also be more values for distIndex that we don't know about.
-----
-;''Example''
   if ( CheckInteractDistance("target", 4) ) then
     FollowUnit("target");
@@ Line 34: / Line 21: @@
     -- we're too far away to follow the target
   end
+==Notes==
+* If "unit" is a hostile unit, the return values are the same.  But you obviously won't be able to do things like Trade.