Wikia

WoWWiki

API GetCurrencyListInfo

Talk0
101,311pages on
this wiki
Revision as of 01:31, November 8, 2009 by Starlightblunder (Talk | contribs)

(diff) ←Older revision | Latest revision (diff) | Newer revision → (diff)
WoW API < GetCurrencyListInfo

Returns information about an entry in the currency list.

name, isHeader, isExpanded, isUnused, isWatched, count, extraCurrencyType, icon, itemID
 = GetCurrencyListInfo(index)

Arguments Edit

id 
Number - index, ascending from 1 to GetCurrencyListSize().

Return values Edit

name 
String - localized currency (or currency header) name.
isHeader 
Boolean - true if this entry is a header, false otherwise.
isExpanded 
Boolean - true if this entry is an expanded header, false otherwise.
isUnused 
Boolean - true if this entry is a currency marked as unused, false otherwise.
isWatched 
Boolean - true if this entry is a currency currently displayed on the backpack, false otherwise.
count 
Number - amount of this currency in the player's possession (0 for headers).
extraCurrencyType 
Number - 1 for arena points, 2 for honor points; 0 otherwise (an item-based currency).
icon 
String - path to the icon texture for item-based currencies, invalid for arena/honor points.
itemID 
Number - item ID corresponding to this item-based currency, invalid for arena/honor points.

Notes Edit

  • Information about currencies under collapsed headers is available; it is up to the UI code to respect the isExpanded flag.
  • Indices are generally based on localized alphabetic order.
  • The headers "contain" all currencies with index greater than theirs until the next header. This is not a nested structure.
  • Marking a currency as unused alters its index, as the currency is moved down the list to fit under an "Unused" header.

Around Wikia's network

Random Wiki