 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
Returns info for a currency by ID.
info = C_CurrencyInfo.GetCurrencyInfo(type)
= C_CurrencyInfo.GetCurrencyInfoFromLink(link)
Arguments[]
GetCurrencyInfo[]
- type
- number : CurrencyID
GetCurrencyInfoFromLink[]
- link
- string : currencyLink
Returns[]
- info
- 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[]
Patch 9.0.1 (2020-10-13): Moved to C_CurrencyInfo.GetCurrencyInfo() and returns structured data.
Patch 4.0.1 (2010-10-12): Added as name, currentAmount, texture, earnedThisWeek, weeklyMax, totalMax, isDiscovered, rarity = GetCurrencyInfo(id)