C_CurrencyInfo.GetCurrencyListInfo

From Warcraft Wiki
Jump to navigation Jump to search

Returns info for a currency in the currency tab.

info = C_CurrencyInfo.GetCurrencyListInfo(index)

Arguments

index
number

Returns

info
CurrencyInfo
Field Type Description
name string Localized name of the currency
description string 10.0.0
currencyID number 11.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
currencyListDepth number 11.0.0 - 1 for the first entry under a top-level header, 0 otherwise, seems to be used to control indentation in the Currency Frame
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 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 9.0.2 - 0 if useTotalEarnedForMaxQty is false, prevents earning if equal to maxQuantity
discovered boolean Whether the character has ever earned the currency
useTotalEarnedForMaxQty boolean 9.0.2 - Whether the currency has a moving maximum (e.g. seasonal)
isAccountWide boolean 11.0.0 - Whether the currency is account-wide, currently only true for [Trader's Tender]
isAccountTransferable boolean 11.0.0 - Whether the currency is Warband Transferrable
transferPercentage number 11.0.0 - The percentage gained when transfering a currency with a transfer tax = the inverse of the tax rate - value is 0 for currencies that don't have a tax
rechargingCycleDurationMS number 11.0.0 - The time in milliseconds it takes for one recharge of the currency, used for the current season's Catalyst charges;
rechargingAmountPerCycle number 11.0.0 - The amount of currency per recharge, used for the current season's Catalyst charges

Patch changes

  • Shadowlands-Icon-Inline.png Patch 9.0.1 (2020-10-13): Moved to C_CurrencyInfo.GetCurrencyListInfo()
  • Wrath-Logo-Small.png Patch 3.1.0 (2009-04-14): Added as name, isHeader, isExpanded, isUnused, isWatched, count, icon, maximum, hasWeeklyLimit, currentWeeklyAmount, unknown, itemID = GetCurrencyListInfo(index)