WoW:API GameTooltip SetBagItem: Difference between revisions

m
Move page script moved page API GameTooltip SetBagItem to WoW:API GameTooltip SetBagItem without leaving a redirect
No edit summary
 
m (Move page script moved page API GameTooltip SetBagItem to WoW:API GameTooltip SetBagItem without leaving a redirect)
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<center>'''GameTooltip:SetBagItem''' ''-Documentation by [[user:Xenoveritas|Xenoveritas]]-''</center>
{{widgetmethod}}


<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  hasCooldown, repairCost = GameTooltip:SetBagItem(bag, slot);
 
  hasCooldown, repairCost = GameTooltip:SetBagItem(bagId, itemId);
 
<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->


Sets the GameTooltip to contain text information about the specified item, as well as returning whether the item is "cooling down" and the cost to repair the item (which may be 0 (or nil?) if non-applicable).
Sets the GameTooltip to contain text information about the specified item, as well as returning whether the item is "cooling down" and the cost to repair the item (which may be 0 (or nil?) if non-applicable).
Line 12: Line 8:
;''Arguments''
;''Arguments''


<!-- List each argument, together with its type -->
:(bag, slot)
 
:;bag: Numeric - the ID of the bag
:(bagId, itemId)
:;slot: Numeric - the ID of the slot
:;bagId : Integer? - the ID of the bag
:;itemId : Integer? - the ID of the item


----
----
;''Returns''
;''Returns''
<!-- List each return value, together with its type -->


:hasCooldown, repairCost
:hasCooldown, repairCost
Line 29: Line 21:
----
----
;''Details''
;''Details''
<!-- Details not appropriate for the main description can go here -->


: This simply sets the text of the game tooltip to contain various information about the item under the given slot.
: This simply sets the text of the game tooltip to contain various information about the item under the given slot.
----
{{Template:WoW API}}
<!-- Update the category to the appropriate subsection, and be sure to put the function name as the label for the category link. Multiple subcategories are okay if appropriate, please dont link functions to the API Functions category directly. -->
[[Widget_API#GameTooltip|GameTooltip]]
Anonymous user