WoW API: GetCursorInfo

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 < GetCursorInfo

Gets information about something the cursor is holding. The information returned depends on what the cursor has.

infoType, info1[, info2] = GetCursorInfo()

Returns

• "item", itemID, itemLink

  "item" : String - The cursor is holding an item.

  itemId: Number - The itemId.

  itemLink : String (ItemLink) - The item's link.

• "spell", spellid, bookType

  "spell" : String - The cursor is holding a spell.

  spellid : Number - The index of the spell in the spell book.

  bookType : String - The spell book id. Only works for player spells, so this always returns BOOKTYPE_SPELL.

• "petaction", spellID, actionID

  "petaction" : String - The cursor is holding a macro.

  spellID : Number - The spell ID

  actionID : Number - The pet action ID.

• "macro", index

  "macro" : String - The cursor is holding a macro.

  index : Number - The index of the macro.

• "flyout", flyoutId, textureId

  "flyout" : String - The cursor is holding a spell flyout button.

  flyoutId : Number - The flyout id.

  textureId : Number - The texture associated with the flyout.

• "money", amount

  "money" : String - The cursor is holding money.

  amount : Number - The amount of money in copper.

• "merchant", index

  "merchant" : String - The cursor is holding a merchant item.

  index : Number - The index of the merchant item.

Example

local infoType, info1, info2 = GetCursorInfo()
if (infoType == "item") then
  print(info2)
elseif (infoType == "spell") then
  local name, rank = GetSpellName(info1, info2)
  if (rank ~= "") then
    name = name .. "(" .. rank .. ")"
  end
  print(name)
end

Result

If the cursor is holding an item, its item link is displayed in the default chat window.