DepositBoxAPI
Deposit Box API.
ClassRLPlugins API
public class DepositBoxAPIMembers
Static methods
- voidcancelQuantityRequest()
Cancels only a numeric input requested by this owner.
- voidclose()
Closes the deposit box interface.
- voiddeposit(String, int)
Deposits the specified amount of an item from the inventory by its name.
- voiddeposit(int, int)
Deposits the specified amount of an item from the inventory by its ID.
- voiddepositAll()
Deposits all items from the inventory.
- voiddepositAllExcept(String...)
Deposits all items from inventory except the specified item IDs.
- voiddepositAllExcept(int...)
Deposits all items from inventory except the specified item IDs.
- voiddepositLootingBag()
Deposits all items from the looting bag.
- voiddepositWorn(EquipmentSlot)
Deposits a worn item from the specified equipment slot.
- voiddepositWorn(String)
Deposits a specific worn item by item name.
- voiddepositWorn(int)
Deposits a specific worn item by item ID.
- voiddepositWornItems()
Deposits all worn items.
- booleanisOpen()
Checks if the deposit box is currently open.
- booleanrequestDeposit(int, int)
Deposits a live inventory item without waiting inside an event callback.
cancelQuantityRequest()static
public static void cancelQuantityRequest()Cancels only a numeric input requested by this owner.
close()static
public static void close()Closes the deposit box interface.
deposit(String, int)static
public static void deposit(String name, int amount)Deposits the specified amount of an item from the inventory by its name.
Parameters
name- The item name to deposit (exact match).
amount- The amount to deposit (1, 5, 10, -1 for all, or a specific value).
- Can wait for the game. Call it only from
VitaPlugin.loop(); in a@Subscribemethod it freezes the game.
deposit(int, int)static
public static void deposit(int id, int amount)Deposits the specified amount of an item from the inventory by its ID.
Parameters
id- The item ID to deposit.
amount- The amount to deposit (1, 5, 10, -1 for all, or a specific value).
- Can wait for the game. Call it only from
VitaPlugin.loop(); in a@Subscribemethod it freezes the game.
depositAll()static
public static void depositAll()Deposits all items from the inventory.
depositAllExcept(String...)static
public static void depositAllExcept(String... excludedIds)Deposits all items from inventory except the specified item IDs.
Parameters
excludedIds- Item IDs to keep in inventory.
- Can wait for the game. Call it only from
VitaPlugin.loop(); in a@Subscribemethod it freezes the game.
depositAllExcept(int...)static
public static void depositAllExcept(int... excludedIds)Deposits all items from inventory except the specified item IDs.
Parameters
excludedIds- Item IDs to keep in inventory.
- Can wait for the game. Call it only from
VitaPlugin.loop(); in a@Subscribemethod it freezes the game.
depositLootingBag()static
public static void depositLootingBag()Deposits all items from the looting bag.
depositWorn(EquipmentSlot)static
public static void depositWorn(EquipmentSlot slot)Deposits a worn item from the specified equipment slot.
Parameters
slot- The equipment slot to deposit from.
depositWorn(String)static
public static void depositWorn(String name)Deposits a specific worn item by item name.
Parameters
name- The item name to deposit.
depositWorn(int)static
public static void depositWorn(int id)Deposits a specific worn item by item ID.
Parameters
id- The item ID to deposit.
depositWornItems()static
public static void depositWornItems()Deposits all worn items.
isOpen()static
public static boolean isOpen()Checks if the deposit box is currently open.
Returns
True if the deposit box interface is open, false otherwise.
requestDeposit(int, int)static
public static boolean requestDeposit(int id, int amount)Deposits a live inventory item without waiting inside an event callback.
Returns true after dispatch; false while an X input is opening or when unavailable. Call again on later ticks for X preparation. Amount -1 means all.
Parameters
id- Id.
amount- Amount.
Also allowed
Every class has these, as in plain Java.
equals, toString