Package net.storm.api.items

Interface IDepositBox

public interface IDepositBox
Provides an interface for interacting with deposit boxes.

Deposit boxes are found throughout the game world and allow players to quickly deposit items into their bank without full bank access. Unlike regular banks, deposit boxes only allow depositing items, not withdrawing them.

Features available through deposit boxes:

  • Deposit all inventory items at once
  • Deposit all equipped items
  • Deposit looting bag contents
  • Configure deposit quantities (1, 5, 10, X, or All)

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Closes the deposit box interface.
    void
    depositEquipment()
    Deposits all currently equipped items into the bank.
    void
    depositInventory()
    Deposits all items from the player's inventory into the bank.
    void
    depositLootingBag()
    Deposits all items from the looting bag into the bank.
    boolean
    isOpen()
    Checks if the deposit box interface is currently open.
    void
    selectQuantityAll()
    Selects the deposit quantity to all items.
    void
    selectQuantityFive()
    Selects the deposit quantity to 5 items per click.
    void
    selectQuantityOne()
    Selects the deposit quantity to 1 item per click.
    void
    selectQuantityTen()
    Selects the deposit quantity to 10 items per click.
    void
    selectQuantityX()
    Selects the deposit quantity to a custom amount (X).

  • Method Details

    • depositInventory

      void depositInventory()
      Deposits all items from the player's inventory into the bank.

      This performs a bulk deposit of the entire inventory contents.

    • depositEquipment

      void depositEquipment()
      Deposits all currently equipped items into the bank.

      This removes all equipment and places it in the bank.

    • depositLootingBag

      void depositLootingBag()
      Deposits all items from the looting bag into the bank.

      The looting bag must be in the player's inventory for this to work.

    • selectQuantityOne

      void selectQuantityOne()
      Selects the deposit quantity to 1 item per click.

      After calling this, clicking on items will deposit 1 at a time.

    • selectQuantityFive

      void selectQuantityFive()
      Selects the deposit quantity to 5 items per click.

      After calling this, clicking on items will deposit 5 at a time.

    • selectQuantityTen

      void selectQuantityTen()
      Selects the deposit quantity to 10 items per click.

      After calling this, clicking on items will deposit 10 at a time.

    • selectQuantityX

      void selectQuantityX()
      Selects the deposit quantity to a custom amount (X).

      After calling this, clicking on items will prompt for a custom quantity to deposit.

    • selectQuantityAll

      void selectQuantityAll()
      Selects the deposit quantity to all items.

      After calling this, clicking on items will deposit all of that item type.

    • isOpen

      boolean isOpen()
      Checks if the deposit box interface is currently open.
      Returns:
      true if the deposit box is open, false otherwise

    • close

      void close()
      Closes the deposit box interface.