DepositBox

object DepositBox

DepositBox A utility class for depositing items, opening and closing a deposit box, and finding the closest usable bank deposit box.

Types

Amount

enum Amount : Enum<DepositBox.Amount>

Functions

@JvmStatic

fun close(): Boolean

Attempts to close the deposit box using mouse.

deposit

@JvmStatic

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

@JvmStatic

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

Attempts to deposit the specified item into the deposit box.

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.

depositInventory

@JvmStatic

fun depositInventory(): Boolean

Attempts to deposit the inventory into the deposit box.

depositLoot

@JvmStatic

fun depositLoot(): Boolean

Attempts to deposit loot into the deposit box.

depositWornItems

@JvmStatic

fun depositWornItems(): Boolean

Attempts to deposit the player's equipment into the deposit box.

get

@JvmStatic

@JvmOverloads

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

{@inheritDoc}

nil

@JvmStatic

fun nil(): Item

opened

@JvmStatic

fun opened(): Boolean

Whether or not the deposit box is currently opened.

stream

@JvmStatic

fun stream(): DepositBoxItemStream

{@inheritDoc}