WoW API: IsItemInRange

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

→ WoW API

← WoW API < IsItemInRange

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

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

Parameters

Arguments

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

itemId

Integer - The numeric ID of the item. ie. 12345

itemName

String - The Name of the Item, e.g. "Heavy Silk Bandage"

itemLink

String - The itemLink, when Shift-Clicking items.

unit

String - The unitId for which the check is done.

Returns

result

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

Example

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

Common Ranges

Bandages: 18 yards