Bank

object Bank

Bank A utility class for withdrawing and depositing items, opening and closing the bank, and finding the closest usable bank.

Types

Amount

enum Amount : Enum<Bank.Amount>

Amount An enumeration providing standard bank amount options. X is the relative to whatever the current value of X is.

Functions

@JvmOverloads

@JvmStatic

fun close(key: Boolean = false): Boolean

Closes the bank.

currentTab

@JvmStatic

fun currentTab(): Int

@JvmStatic

fun currentTab(index: Int): Boolean

Changes the current tab to the provided index.

deposit

@JvmStatic

fun deposit(id: Int, amount: Int): Boolean

@JvmStatic

fun deposit(id: Int, amount: Bank.Amount): Boolean

Deposits an item with the provided id and amount.

@JvmStatic

fun deposit(name: String, amount: Int): Boolean

@JvmStatic

fun deposit(name: String, amount: Bank.Amount): Boolean

Deposits an item with the provided name and amount.

depositAllExcept

@JvmStatic

fun depositAllExcept(vararg names: String?): Boolean

Deposits the players inventory excluding the specified item names.

@JvmStatic

fun depositAllExcept(vararg ids: Int): Boolean

Deposits the players inventory excluding the specified ids.

@JvmStatic

fun depositAllExcept(filter: Filter<Item>): Boolean

Deposits the players inventory excluding the items that match the provided filter.

depositEquipment

@JvmStatic

fun depositEquipment(): Boolean

depositInventory

@JvmStatic

fun depositInventory(): Boolean

get

@JvmStatic

@JvmOverloads

fun get(predicate: Predicate<Item>? = null): List<Item>

{@inheritDoc}

getBank

fun getBank(): InteractableEntity

Finds the nearest bank InteractableEntity can be either Npc or GameObject

inViewport

@JvmStatic

fun inViewport(): Boolean

nearest

@JvmStatic

fun nearest(): Locatable

Returns the absolute nearest bank for walking purposes. Do not use this to open the bank.

Nil

@JvmStatic

fun Nil(): Item

open

@JvmStatic

fun open(): Boolean

Opens a random in-view bank. Do not continue execution within the current first after this method so BankPin may activate.

opened

@JvmStatic

fun opened(): Boolean

present

@JvmStatic

fun present(): Boolean

Determines if a bank is present in the loaded region.

quantityComponentValue

@JvmStatic

fun quantityComponentValue(amount: Bank.Amount?): Int

Gives the component value of the quantity amount to be used.

stream

@JvmStatic

fun stream(): BankItemStream

{@inheritDoc}

tabbed

@JvmStatic

fun tabbed(): Boolean

tabItem

@JvmStatic

fun tabItem(index: Int): Item

Returns the item in the specified tab if it exists.

withdraw

@JvmStatic

fun withdraw(id: Int, amount: Int): Boolean

@JvmStatic

fun withdraw(id: Int, amount: Bank.Amount): Boolean

Withdraws an item with the provided id and amount.

@JvmStatic

fun withdraw(name: String, amount: Int): Boolean

@JvmStatic

fun withdraw(name: String, amount: Bank.Amount): Boolean

@JvmStatic

fun withdraw(name: String, amount: Int, waitFor: Callable<Boolean>): Boolean

@JvmStatic

fun withdraw(name: String, amount: Bank.Amount, waitFor: Callable<Boolean>): Boolean

Withdraws an item with the provided name and amount. If multiple items of the same name are present, the first one is chosen.

@JvmStatic

fun withdraw(filter: Filter<Item>, amount: Int): Boolean

@JvmStatic

fun withdraw(filter: Filter<Item>, amount: Bank.Amount): Boolean

@JvmStatic

fun withdraw(filter: Filter<Item>, amount: Int, waitFor: Callable<Boolean>): Boolean

@JvmStatic

fun withdraw(filter: Filter<Item>, amount: Bank.Amount, waitFor: Callable<Boolean>): Boolean

Withdraws an item with the provided name and amount. If multiple items match the filter, the first one is chosen.

@JvmStatic

fun withdraw(item: Item, amount: Int): Boolean

Withdraws an item with the provided item and amount.

@JvmStatic

fun withdraw(id: Int, amount: Int, waitFor: Callable<Boolean>): Boolean

@JvmStatic

fun withdraw(id: Int, amount: Bank.Amount, waitFor: Callable<Boolean>): Boolean

Withdraws an item with the provided name and amount.

@JvmStatic

fun withdraw(item: Item, amount: Int, waitFor: Callable<Boolean>): Boolean

Withdraws the specified amount of the specified item and waits for the specified condition to be true.

withdrawAmount

@JvmStatic

fun withdrawAmount(id: Int, amount: Int): Int

@JvmStatic

fun withdrawAmount(id: Int, amount: Bank.Amount): Int

@JvmStatic

fun withdrawAmount(name: String, amount: Int): Int

@JvmStatic

fun withdrawAmount(name: String, amount: Bank.Amount): Int

@JvmStatic

fun withdrawAmount(filter: Filter<Item>, amount: Int): Int

@JvmStatic

fun withdrawAmount(filter: Filter<Item>, amount: Bank.Amount): Int

@JvmStatic

fun withdrawAmount(item: Item, amount: Int): Int

Withdraws the specified amount of the specified item.

withdrawModeNoted

@JvmStatic

fun withdrawModeNoted(): Boolean

@JvmStatic

fun withdrawModeNoted(noted: Boolean): Boolean

withdrawModeQuantity

@JvmStatic

fun withdrawModeQuantity(): Bank.Amount

Returns the currently filtered withdraw mode.

@JvmStatic

fun withdrawModeQuantity(amount: Bank.Amount): Boolean

filter or verify the current withdraw quantity mode within the bank. Bank must be opened if you intend to set, but can be checked without opening.

withdrawXAmount

@JvmStatic

fun withdrawXAmount(): Int

Check the current amount that is set to Withdraw-X