WoW:API GameTooltip SetBagItem: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
({{widgetmethod}})
No edit summary
Line 5: Line 5:
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->


  hasCooldown, repairCost = GameTooltip:SetBagItem(bagId, itemId);
  hasCooldown, repairCost = GameTooltip:SetBagItem(bag, slot);


<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
Line 16: Line 16:
<!-- List each argument, together with its type -->
<!-- List each argument, together with its type -->


:(bagId, itemId)
:(bag, slot)
:;bagId : Integer? - the ID of the bag
:;bag: Numeric - the ID of the bag
:;itemId : Integer? - the ID of the item
:;slot: Numeric - the ID of the slot


----
----

Revision as of 15:16, 11 July 2006

Widget API ← GameTooltip < SetBagItem

GameTooltip:SetBagItem -Documentation by Xenoveritas-


hasCooldown, repairCost = GameTooltip:SetBagItem(bag, slot);


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).


Arguments


(bag, slot)
bag
Numeric - the ID of the bag
slot
Numeric - the ID of the slot

Returns


hasCooldown, repairCost
hasCooldown
Boolean - if the item currently has a cooldown
repairCost
Integer - the cost to repair the item, may be 0 or nil if the item cannot be repaired.

Details


This simply sets the text of the game tooltip to contain various information about the item under the given slot.