C_Bank

namespaceavailable in: camelot

Status in wowlua

26 functions: 15 implemented, 2 recorded, 9 guessed. 7 events, 5 of them fired by the emulator on its own.

Functions

function	what it does	status
`AreAnyBankTypesViewable`	Whether any bank can be viewed. · by wowlua `(): boolean`	implemented
`AutoDepositItemsIntoBank`	Moves the items that belong in the bank into it. · by wowlua `(bankType: BankType)`	guessed
`BankBagTypeAndIDToInvSlot`	Returns the inventory slot of the bank's tab, or nil when it has none. · by wowlua `(bankType: BankType, slotIndex: number): number?`	guessed
`CanDepositMoney`	Whether money can be deposited into the bank. · by wowlua `(bankType: BankType): boolean`	implemented
`CanPurchaseBankTab`	Whether the player can buy a tab for the bank. · by wowlua `(bankType: BankType): boolean`	implemented
`CanUseBank`	Whether the player can use the bank. · by wowlua `(bankType: BankType): boolean`	implemented
`CanViewBank`	Whether the player can view the bank. · by wowlua `(bankType: BankType): boolean`	implemented
`CanWithdrawMoney`	Whether money can be withdrawn from the bank. · by wowlua `(bankType: BankType): boolean`	implemented
`CloseBankFrame`	Closes the bank and ends the interaction with the banker. · by wowlua `()`	implemented
`DepositMoney`	Deposits money into the given bank. · by wowlua `(bankType: BankType, amount: WOWMONEY)`	guessed
`DoesBankTypeSupportAutoDeposit`	Whether the bank type supports depositing items automatically. · by wowlua `(bankType: BankType): boolean`	guessed
`DoesBankTypeSupportMoneyTransfer`	Whether money can be deposited into and withdrawn from the bank type. · by wowlua `(bankType: BankType): boolean`	guessed
`FetchBankLockedReason`	Returns why the bank type is locked, or nil when it is usable. · by wowlua `(bankType: BankType): BankLockedReason?`	implemented
`FetchDepositedMoney`	Returns the money deposited in the given bank, in copper. · by wowlua `(bankType: BankType): WOWMONEY`	implemented
`FetchMaxNumBankTabs`	Returns the most tabs the bank type can have. · by wowlua `(bankType: BankType): number`	recorded
`FetchNextPurchasableBankTabData`	Returns information about the next bank tab that can be bought, such as its cost, or nil when there is none. · by wowlua `(bankType: BankType): PurchasableBankTabData?`	implemented
`FetchNumPurchasedBankTabs`	Returns how many tabs of the bank type have been bought. · by wowlua `(bankType: BankType): number`	implemented
`FetchPurchasedBankTabData`	Returns information on all already bought bank tabs for the given bank type along a number of necessary information by tab. `(bankType: BankType): BankTabData[]`	implemented
`FetchPurchasedBankTabIDs`	Returns the bag IDs of the bank type's purchased tabs. · by wowlua `(bankType: BankType): BagIndex[]`	guessed
`FetchViewableBankTypes`	Returns the bank types the player can view right now; none away from a banker. · by wowlua `(): BankType[]`	guessed
`HasMaxBankTabs`	Whether all tabs of the bank type have been bought. · by wowlua `(bankType: BankType): boolean`	implemented
`IsItemAllowedInBankType`	Whether the item may be stored in the bank type. · by wowlua `(bankType: BankType, itemLocation: ItemLocationMixin): boolean`	implemented
`PurchaseBankTab`	Buys the next tab of the bank type. · by wowlua `(bankType: BankType)`	implemented
`ShouldUsePlayerBagsInBank`	Whether the bank interface should show the player's bags. · by wowlua `(): boolean`	recorded
`UpdateBankTabSettings`	Changes a bank tab's name, icon and deposit settings. · by wowlua `(bankType: BankType, tabID: BagIndex, tabName: string, tabIcon: string, depositFlags: BagSlotFlags)`	guessed
`WithdrawMoney`	Withdraws money from the given bank. · by wowlua `(bankType: BankType, amount: WOWMONEY)`	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
`BANKFRAME_CLOSED`	`no payload`	implemented
`BANKFRAME_OPENED`	`no payload`	implemented
`BANK_BAG_SLOT_FLAGS_UPDATED`	`slot: number`	not implemented
`BANK_TABS_CHANGED`	`bankType: BankType`	implemented
`BANK_TAB_SETTINGS_UPDATED`	`bankType: BankType`	implemented
`PLAYERBANKSLOTS_CHANGED`	`slot: number`	implemented
`PLAYER_ACCOUNT_BANK_TAB_SLOTS_CHANGED`	`slot: number`	not implemented

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

Structures

BankTabData · ID, bankType, name, icon, depositFlags, tabCleanupConfirmation, tabNameEditBoxHeader
PurchasableBankTabData · tabCost, canAfford, purchasePromptTitle, purchasePromptBody, purchasePromptConfirmation

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (Bank 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.