API GetCurrencyInfo

From Wowpedia
Jump to: navigation, search

Retrieve Information about a currency at index including it's amount.

name, currentAmount, texture, earnedThisWeek, weeklyMax, totalMax, isDiscovered, rarity = GetCurrencyInfo(id or "currencyLink" or "currencyString")

Arguments

One of the following three ways to specify which currency to query:

id 
Integer - CurrencyID
currencyLink 
String - The full currencyLink as found with GetCurrencyLink() or GetCurrencyListLink().
currencyString 
String - A fragment of the currencyLink string for the item, e.g. "currency:396" for Valor Points.

Returns

name 
String - the name of the currency, localized to the language
amount 
Number - Current amount of the currency at index
texture 
String - The file name of the currency's icon. As of 5.2.0, does include the path (\\Interface\\Icons\\)
earnedThisWeek 
Number - The amount of the currency earned this week
weeklyMax 
Number - Maximum amount of currency possible to be earned this week
totalMax 
Number - Total maximum currency possible to stockpile
isDiscovered 
Boolean - Whether the character has ever got some of this currency
rarity 
Integer - Rarity indicator for this currency

Patch changes

  • Some time after Patch 4.0.1, the returns changed from "localized_label, amount, icon_file_name = GetCurrencyInfo(id)" to "name, currentAmount, texture, unknown, weeklyMax, totalMax = GetCurrencyInfo(id)"

External links

Icon-wowhead-22x22.png Wowhead