DepositBox

Group
bank
Methods
7
Fields
None

Getting one

bank:depositBox()

Methods

MethodReturnsDescription
isOpen()booleanWhether the deposit box interface is open.
open()booleanOpen the nearest deposit box. Already open is success.
close()booleanClose the deposit box with its close button.
depositInventory()booleanPress the box's Deposit inventory button.
depositEquipment()booleanPress the box's Deposit worn items button.
depositContainers()booleanPress the box's button that empties the looting bag and other containers.
deposit(number, number | "all")(RunStatus, string?)One step towards depositing an amount of a carried item. Call it each tick until it answers "done", and amount goes in once, not again…

Returned by

MethodReturnsDescription
Bank.depositBoxDepositBoxThe deposit box interface.

Method details

open

open: (DepositBox) -> boolean

Open the nearest deposit box. Already open is success.

Returns
false when none is in range.

close

close: (DepositBox) -> boolean

Close the deposit box with its close button.

Returns
false when it is not open.

depositInventory

depositInventory: (DepositBox) -> boolean

Press the box's Deposit inventory button.

Returns
false when it is not open.

depositEquipment

depositEquipment: (DepositBox) -> boolean

Press the box's Deposit worn items button.

Returns
false when it is not open.

depositContainers

depositContainers: (DepositBox) -> boolean

Press the box's button that empties the looting bag and other containers.

Returns
false when it is not open.

deposit

deposit: (DepositBox, number, number | "all") -> (RunStatus, string?)

One step towards depositing an amount of a carried item. Call it each tick until it answers "done", and amount goes in once, not again each call. An amount other than 1, 5, 10 or "all" opens the amount prompt, and a later call types into it.

itemId
Exact item id.
amount
A whole number from 1, or "all".
Returns
"running" while it is being made, "done" once it has landed or there is nothing to do (the box is shut, the item is not carried), and "blocked" with the reason when it could not be queued.