 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards.
|
Returns information about currencies in the currency tab.
info = C_CurrencyInfo.GetCurrencyInfo(currencyType)
Arguments
- currencyType
- number - See CurrencyID.
Returns
- info
- CurrencyInfo
CurrencyInfo
| Field |
Type |
Description
|
| name |
string |
Localized name of the currency
|
| description |
string |
Added in 10.0.0
|
| isHeader |
boolean |
Used by currency window (some currency IDs are the headers)
|
| isHeaderExpanded |
boolean |
Whether header is expanded or collapsed in currency window
|
| isTypeUnused |
boolean |
Sorts currency at the bottom of currency window in "Unused" header
|
| isShowInBackpack |
boolean |
Shows currency on Blizzard backpack frame
|
| quantity |
number |
Current amount of the currency
|
| trackedQuantity |
number |
Added in 9.1.5
|
| iconFileID |
number |
FileID
|
| maxQuantity |
number |
Total maximum currency possible
|
| canEarnPerWeek |
boolean |
Whether the currency is limited per week
|
| quantityEarnedThisWeek |
number |
0 if canEarnPerWeek is false
|
| isTradeable |
boolean |
|
| quality |
Enum.ItemQuality🔗 |
|
| maxWeeklyQuantity |
number |
0 if canEarnPerWeek is false
|
| totalEarned |
number |
Added in 9.0.2; Returns 0 if useTotalEarnedForMaxQty is false, prevents earning if equal to maxQuantity
|
| discovered |
boolean |
Whether the character has ever earned the currency
|
| useTotalEarnedForMaxQty |
boolean |
Added in 9.0.2; Whether the currency has a moving maximum (e.g. seasonal)
|
Patch changes
External links
Patch 9.0.1 (2020-10-13): Added, replacing GetCurrencyInfo(). 
GitHub FrameXML, Gethe
