WoW:API GetCursorInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(commas unrequired)
m (Move page script moved page API GetCursorInfo to API GetCursorInfo without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 8: Line 8:
*:itemId: Number - The itemId.
*:itemId: Number - The itemId.
*:itemLink : String ([[ItemLink]]) - The item's link.
*:itemLink : String ([[ItemLink]]) - The item's link.
*"spell", spellid, bookType
*"spell", spellid, bookType
*:"spell" : String - The cursor is holding a spell.
*:"spell" : String - The cursor is holding a spell.
*:spellid : Number - The index of the spell in the spell book.
*: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.
*: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", index
*:"macro" : String - The cursor is holding a macro.
*:"macro" : String - The cursor is holding a macro.
*:index : Number - The index of the 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", amount
*:"money" : String - The cursor is holding money.
*:"money" : String - The cursor is holding money.
*:amount : Number - The amount of money in copper.
*:amount : Number - The amount of money in copper.
*"merchant", index
*"merchant", index
*:"merchant" : String - The cursor is holding a merchant item.
*:"merchant" : String - The cursor is holding a merchant item.

Latest revision as of 04:45, 15 August 2023

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[edit]

  • "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[edit]

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.