C_CurrencyInfo

namespaceavailable in: camelot

Status in wowlua

43 functions: 4 implemented, 1 recorded, 38 guessed. 8 events, 2 of them fired by the emulator on its own.

Functions

function	what it does	status
`CanTransferCurrency`	Whether a currency can be transferred between the account's characters, and the reason when it can't. · by wowlua `(currencyID: number): (boolean, AccountCurrencyTransferResult?)`	guessed
`DoesCurrentFilterRequireAccountCurrencyData`	Whether the current currency filter needs the currency data of the account's other characters. · by wowlua `(): boolean`	recorded
`DoesWarModeBonusApply`	Whether the War Mode bonus applies to a currency. · by wowlua `(currencyID: number): (boolean?, boolean?)`	guessed
`ExpandCurrencyList`	Expands/collapses a currency list header. `(index: number, expand: boolean)`	guessed
`FetchCurrencyDataFromAccountCharacters`	Returns the amounts of a currency the account's other characters hold. · by wowlua `(currencyID: number): CharacterCurrencyData[]?`	guessed
`FetchCurrencyTransferTransactions`	Returns the account's recent currency transfers. · by wowlua `(): CurrencyTransferTransaction[]`	guessed
`GetAzeriteCurrencyID`	Returns the currency ID of Azerite. · by wowlua `(): number`	guessed
`GetBackpackCurrencyInfo`	Returns info for a tracked currency in the backpack. `(index: number): BackpackCurrencyInfo?`	implemented
`GetBasicCurrencyInfo`	Returns display information about a currency. · by wowlua `(currencyType: number, quantity: number?): CurrencyDisplayInfo?`	guessed
`GetCoinIcon`	Returns the icon of the largest coin (gold, silver or copper) in an amount of money. · by wowlua `(amount: WOWMONEY): number`	guessed
`GetCoinText`	Breaks up an amount of money into gold/silver/copper. `(amount: WOWMONEY, separator: string): string`	guessed
`GetCoinTextureString`	Breaks up an amount of money into gold/silver/copper with icons. `(amount: WOWMONEY, fontHeight: number): string`	implemented
`GetCostToTransferCurrency`	Returns the cost of transferring an amount of a currency. · by wowlua `(currencyID: number, quantity: number): number?`	guessed
`GetCurrencyContainerInfo`	Returns display information about a currency container holding an amount of a currency. · by wowlua `(currencyType: number, quantity: number): CurrencyDisplayInfo?`	guessed
`GetCurrencyDescription`	Returns a currency's description. · by wowlua `(type: number): string`	guessed
`GetCurrencyFilter`	Returns the currency list's filter. · by wowlua `(): CurrencyFilterType`	guessed
`GetCurrencyIDFromLink`	Converts currency links to IDs. `(currencyLink: string): number`	guessed
`GetCurrencyInfo`	Returns info for a currency by ID. `(type: number): CurrencyInfo?`	guessed
`GetCurrencyInfoFromLink`	Returns information about currencies from a link. `(link: string): CurrencyInfo?`	guessed
`GetCurrencyLink`	Returns a currency link. `(type: number, amount: number?): string`	guessed
`GetCurrencyListInfo`	Returns info for a currency in the currency tab. `(index: number): CurrencyInfo?`	implemented
`GetCurrencyListLink`	Get the currencyLink for the specified currency list index. `(index: number): string`	guessed
`GetCurrencyListSize`	Returns the amount of currencies and headers in the currency tab. `(): number`	implemented
`GetDragonIslesSuppliesCurrencyID`	Returns the currency ID of Dragon Isles Supplies. · by wowlua `(): number`	guessed
`GetFactionGrantedByCurrency`	Gets the faction ID for currency that is immediately converted into reputation with that faction instead. `(currencyID: number): number?`	guessed
`GetMaxTransferableAmountFromQuantity`	Returns the most of a currency that can be transferred out of the requested amount. · by wowlua `(currencyID: number, requestedQuantity: number): number?`	guessed
`GetPlayerCurrencyCategoryInfo`	Returns information about a currency category. · by wowlua `(categoryID: number, includeAccountWide: boolean): PlayerCurrencyCategoryInfo`	guessed
`GetWarResourcesCurrencyID`	Returns the currency ID of War Resources. · by wowlua `(): number`	guessed
`IsAccountCharacterCurrencyDataReady`	Whether the currency data of the account's other characters has loaded. · by wowlua `(): boolean`	guessed
`IsAccountTransferableCurrency`	Whether a currency can be transferred between the account's characters. · by wowlua `(currencyID: number): boolean`	guessed
`IsAccountWideCurrency`	Whether a currency is shared by all of the account's characters. · by wowlua `(currencyID: number): boolean`	guessed
`IsCurrencyContainer`	Whether an amount of a currency is shown as a currency container. · by wowlua `(currencyID: number, quantity: number): boolean`	guessed
`IsCurrencyTransferInProgress`	Whether a currency transfer is in progress. · by wowlua `(): boolean`	guessed
`IsCurrencyTransferTransactionDataReady`	Whether the account's currency transfer history has loaded. · by wowlua `(): boolean`	guessed
`PickupCurrency`	Picks up a currency to the cursor. `(type: number)`	guessed
`PlayerHasMaxQuantity`	Whether the player holds the maximum amount of a currency. · by wowlua `(currencyID: number): boolean`	guessed
`PlayerHasMaxWeeklyQuantity`	Whether the player has earned this week's maximum of a currency. · by wowlua `(currencyID: number): boolean`	guessed
`RequestCurrencyDataForAccountCharacters`	Requests the currency data of the account's other characters. · by wowlua `()`	guessed
`RequestCurrencyFromAccountCharacter`	Transfers an amount of a currency from another of the account's characters to the player. · by wowlua `(sourceCharacterGUID: string, currencyID: number, quantity: number)`	guessed
`SetCurrencyBackpack`	Tracks a currency in the backpack. `(index: number, backpack: boolean)`	guessed
`SetCurrencyBackpackByID`	Sets whether a currency is shown in the backpack. · by wowlua `(currencyType: number, backpack: boolean)`	guessed
`SetCurrencyFilter`	Sets the currency list's filter. · by wowlua `(filterType: CurrencyFilterType)`	guessed
`SetCurrencyUnused`	Marks a currency as unused in the currency tab. `(index: number, unused: boolean)`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`ACCOUNT_CHARACTER_CURRENCY_DATA_RECEIVED`	`no payload`	not implemented
`ACCOUNT_MONEY`	`no payload`	not implemented
`CURRENCY_DISPLAY_UPDATE`	`currencyType: number?, quantity: number?, quantityChange: number?, quantityGainSource: number?, destroyReason: number?`	implemented
`CURRENCY_TRANSFER_FAILED`	`failureReason: AccountCurrencyTransferResult`	not implemented
`CURRENCY_TRANSFER_INITIATED`	`no payload`	not implemented
`CURRENCY_TRANSFER_LOG_UPDATE`	`no payload`	not implemented
`CURRENCY_TRANSFER_SUCCESS`	`no payload`	not implemented
`PLAYER_MONEY`	`no payload`	implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("ACCOUNT_CHARACTER_CURRENCY_DATA_RECEIVED").

Structures

BackpackCurrencyInfo · name, quantity, iconFileID, currencyTypesID
CharacterCurrencyData · characterGUID, characterName, fullCharacterName, currencyID, quantity
CurrencyDisplayInfo · name, description, icon, quality, displayAmount, actualAmount
CurrencyInfo · name, description, currencyID, isHeader, isHeaderExpanded, currencyListDepth, isTypeUnused, isShowInBackpack, quantity, trackedQuantity, iconFileID, maxQuantity, canEarnPerWeek, quantityEarnedThisWeek, isTradeable, quality, maxWeeklyQuantity, totalEarned, discovered, useTotalEarnedForMaxQty, isAccountWide, isAccountTransferable, transferPercentage?, rechargingCycleDurationMS, rechargingAmountPerCycle
CurrencyTransferTransaction · sourceCharacterGUID, sourceCharacterName, fullSourceCharacterName, destinationCharacterGUID, destinationCharacterName, fullDestinationCharacterName, currencyType, quantityTransferred, totalQuantityConsumed, timestamp
PlayerCurrencyCategoryInfo · categoryName, currencyTypes, childCategories

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (CurrencySystem system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.