WoW:API IsItemInRange: Difference between revisions

Revision as of 17:36, 4 June 2008

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

Returns if you are in range of the specified unit to use the specified item.

result = IsItemInRange("itemName" or "itemLink", "unit")

("itemName" or "itemLink", "unit")

result: Integer - If in range to perform the action 1. Otherwise 0. nil if the action is invalid.

if ( IsItemInRange("Heavy Silk Bandage","target") ) then
  -- light up a part of the interface
else
  -- darken
end

Bandages: 18 yards

@@ Line 1: / Line 1: @@
-{{wowapi}}
+{{wowapi}}__NOTOC__
+Returns if you are in range of the specified unit to use the specified item.
+ result = IsItemInRange("itemName" or "itemLink", "unit")
-Returns 1 if you are in range of the specified unit to use the item specified by item, 0 if not, nil if the target is invalid, etc.
+== Parameters ==
+=== Arguments ===
+:("itemName" or "[[itemLink]]", "[[unitId|unit]]")
-----
+:;itemName : String - The Name of the Item, e.g. "Heavy Silk Bandage"
-;''Arguments''
+:;[[itemLink]] : String - The [[itemLink]], when Shift-Clicking items.
+:;[[unitId|unit]] : String - The [[unitId]] for which the check is done.
-:(String item, String unit)
+=== Returns ===
+:;result : Integer - If in range to perform the action ''1''. Otherwise ''0''. ''nil'' if the action is invalid.
-:;item : The item to use (e.g. "Heavy Silk Bandage")
+== Example ==
-:;unit : The unit to query (e.g. "target", "party1", "pet", "player")
-----
-Common Ranges
-::::Bandages: 18 yards
-----
-;''Returns''
-:;If in range to perform the action, 1 (true).  Otherwise, 0 (false), or nil (false) if the action is invalid.
-----
-;''Notes''
-----
-;''Example''
   if ( IsItemInRange("Heavy Silk Bandage","target") ) then
     -- light up a part of the interface
@@ Line 30: / Line 20: @@
     -- darken
   end
+== Common Ranges ==
+Bandages: 18 yards