WoW API: GetBackpackCurrencyInfo

Revision as of 01:18, 8 November 2009 by WoWWiki>Starlightblunder (Created page with 'Returns information about a currency item currently being shown as part of the backpack. name, count, extraCurrencyType, icon, itemid = GetBackpackCurrencyInfo(id) == Arguments…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

WoW API < GetBackpackCurrencyInfo

Returns information about a currency item currently being shown as part of the backpack.

name, count, extraCurrencyType, icon, itemid = GetBackpackCurrencyInfo(id)

Arguments

id
Number - Index, ascending from 1 to GetNumWatchedTokens().

Return values

name
String - Localized currency name; or nil if the id argument is out of range.
count
Number - Amount of this currency currently possessed by the player.
extraCurrencyType
Number - 0 for item-based currencies, 1 for arena points, 2 for honor points.
icon
String - Path to the item-based currency texture; invalid for arena/honor points.
itemid
Number - Item ID of the item-based currency item; invalid for arena/honor points.

Notes

  • As of 3.2, up to 3 currencies may be tracked as part of the backpack display. The function does not raise errors on out of range indices.