WoW:API GetCursorInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Changed compound parameter for "spell" to bookType)
(it doesn't return an actionid, but a spellid)
Line 11: Line 11:


*"item", itemID, itemLink
*"item", itemID, itemLink
*:"item" : String - The cursor is holding an item
*:"item" : String - The cursor is holding an item.
*:itemId: Number - The itemId
*:itemId: Number - The itemId.
*:itemLink : String ([[ItemLink]]) - The item's link
*:itemLink : String ([[ItemLink]]) - The item's link.




*"spell", slot, bookType
*"spell", spellid, bookType
*:"spell" : String - The cursor is holding a spell
*:"spell" : String - The cursor is holding a spell.
*:slot : Number ([[ActionSlot]]) - The action slot the spell is from
*:spellid : Number - The index of the spell in the spell book.
*:bookType : String "spell" or "pet" - Whether the spell is a player spell or a pet spell
*:bookType : String - The spell book id. Only works for player spells, so this always returns BOOKTYPE_SPELL.
 


*"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.
 


*"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.
*:index : Number - The index of the merchant item
*:index : Number - The index of the merchant item.


== Example ==
== Example ==

Revision as of 22:49, 15 February 2008

← WoW API < GetCursorInfo


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

"infoType", info1[, info2] = GetCursorInfo()

Arguments

none

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.
  • "macro", index
    "macro" : String - The cursor is holding a macro.
    index : Number - The index of the macro.
  • "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
  DEFAULT_CHAT_FRAME:AddMessage(info2)
end

Result 

If the cursor is holding an item, its item link is displayed in the default chat window.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetCursorInfo&oldid=14074"