WoW:API GetCursorInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Added merchant return)
(Cleaned up the page.)
Line 1: Line 1:
{{cleanup}}
{{wowapi}} __NOTOC__
{{wowapi}}
;''Arguments''
*''none''




;''Returns''
Gets information about something the cursor is holding. The information returned depends on what the cursor has.
*"item", itemID, link = GetCursorInfo()
"infoType", info1[, info2] = GetCursorInfo()
*"spell", slot, "spell" or "pet" = GetCursorInfo()
 
*"macro", index = GetCursorInfo()
== Arguments ==
*"money", amount = GetCursorInfo()
:none
*"merchant", index = 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", slot, "spell" or "pet"
*:"spell" : String - The cursor is holding a spell
*:slot : Number ([[ActionSlot]]) - The action slot the spell is from
*:"spell" or  "pet" : String - Whether the spell is a player spell or a pet 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
 
<big>'''Result'''</big>
If the cursor is holding an item, its item link is displayed in the default chat window.

Revision as of 15:46, 15 June 2007

← 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", slot, "spell" or "pet"
    "spell" : String - The cursor is holding a spell
    slot : Number (ActionSlot) - The action slot the spell is from
    "spell" or "pet" : String - Whether the spell is a player spell or a pet 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=14072"