Package com.kraken.api.query.container.bank

Class BankEntity

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getId()
      The item ID for the wrapped game entity
      java.lang.String getName()
      The game entities name.
      boolean interact​(java.lang.String action)
      Interacts with the entity using the given action verb.
      boolean withdraw​(int amount)
      Withdraws a specific amount.
      boolean withdraw​(int amount, boolean noted)
      Withdraws a specific amount with explicit Note mode selection.
      boolean withdrawAll()
      Withdraws All of this item.
      boolean withdrawAllNoted()
      Withdraws All of this item, ensuring it comes out as Notes.
      boolean withdrawFive()
      Withdraws 5 of this item.
      boolean withdrawOne()
      Withdraws 1 of this item.
      boolean withdrawTen()
      Withdraws 10 of this item.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from interface: Interactable
        The game entities name.
        Returns:
        The name of the game entity i.e. NPC name for NPC's, item name for ContainerItem's, and GameObject name for various game objects.

      • interact

        public boolean interact​(java.lang.String action)
        Description copied from interface: Interactable
        Interacts with the entity using the given action verb.
        Parameters:
        action - The menu action to trigger (e.g., "Attack", "Talk-to", "Take")
        Returns:
        true if the interaction packet was successfully queued/sent

      • getId

        public int getId()
        Description copied from interface: Interactable
        The item ID for the wrapped game entity
        Returns:
        int Item id

      • withdrawOne

        public boolean withdrawOne()
        Withdraws 1 of this item.
        Returns:
        true if the withdrawal was successful and false otherwise

      • withdrawFive

        public boolean withdrawFive()
        Withdraws 5 of this item.
        Returns:
        true if the withdrawal was successful and false otherwise

      • withdrawTen

        public boolean withdrawTen()
        Withdraws 10 of this item.
        Returns:
        true if the withdrawal was successful and false otherwise

      • withdrawAll

        public boolean withdrawAll()
        Withdraws All of this item.
        Returns:
        true if the withdrawal was successful and false otherwise

      • withdrawAllNoted

        public boolean withdrawAllNoted()
        Withdraws All of this item, ensuring it comes out as Notes.
        Returns:
        true if the withdrawal was successful and false otherwise

      • withdraw

        public boolean withdraw​(int amount)
        Withdraws a specific amount. Handles "Withdraw-X" logic including scripts. Defaults to un-noted (Item) mode.
        Parameters:
        amount - The amount of the item to withdraw
        Returns:
        true if the withdrawal was successful and false otherwise

      • withdraw

        public boolean withdraw​(int amount,
                        boolean noted)
        Withdraws a specific amount with explicit Note mode selection.
        Parameters:
        amount - The amount of the item to withdraw: 1, 5, or 10. Any other value will withdraw X of that value
        noted - True if the items should be withdrawn as notes and false if they should be withdrawn as items
        Returns:
        true if the withdrawal was successful and false otherwise