WoW:API GetItemCooldown: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Robot: Automated text replacement (-\[\[\s*(\w[^]|]*\w)\s*\|\s*\1\s*]] +1))
(Updated to match the current API boilerplate.)
Line 1: Line 1:
{{Stub/API}}
{{wowapi}} __NOTOC__
{{wowapi}}
 
 
Returns cooldown information for the item.
Returns cooldown information for the item.
startTime, duration, enable = GetItemCooldown("itemLink");


<pre> startTime, duration, enable = GetItemCooldown("itemLink"); </pre>
==Parameters==


=== Arguments ===
=== Arguments ===
(itemID | "name" | "item link")
:(itemID | "name" | "item link")
;: itemId : Integer - The numeric ID of the item. ie. 12345
:; itemId : Integer - The numeric ID of the item. ie. 12345
 
:; itemName : String - The Name of the Item, ex: "Hearthstone".
;: itemName : String - The Name of the Item, ex: "Hearthstone".
:; "[[itemLink]]" : String - The itemLink, when Shift-Clicking items.
 
;: "[[itemLink]]" : String - The itemLink, when Shift-Clicking items.


=== Returns ===
=== Returns ===
 
:(startTime, duration, enable)
(startTime, duration, enable)
:; startTime : Number - The time when the cooldown started (as returned by [[API GetTime|GetTime()]]) or zero if no cooldown.
 
:; duration : Number - The number of seconds the cooldown will last, or zero if no cooldown.
;: startTime : Number - The time when the cooldown started (as returned by [[API GetTime|GetTime]]()) or zero if no cooldown.
:; enable : [[Boolean]] - 0 if no cooldown, 1 if item got cooldown.
 
;: duration : Number - The number of seconds the cooldown will last, or zero if no cooldown.
 
;: enable : Boolean - 0 if no cooldown, 1 if item got cooldown.

Revision as of 19:15, 25 June 2007

WoW API < GetItemCooldown


Returns cooldown information for the item.

startTime, duration, enable = GetItemCooldown("itemLink");


Arguments

(itemID | "name" | "item link")
itemId
Integer - The numeric ID of the item. ie. 12345
itemName
String - The Name of the Item, ex: "Hearthstone".
"itemLink"
String - The itemLink, when Shift-Clicking items.

Returns

(startTime, duration, enable)
startTime
Number - The time when the cooldown started (as returned by GetTime()) or zero if no cooldown.
duration
Number - The number of seconds the cooldown will last, or zero if no cooldown.
enable
Boolean - 0 if no cooldown, 1 if item got cooldown.