Class BankInventoryEntity

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean deposit​(int amount)
      Deposits a set amount of the given item from the players inventory to the bank.
      boolean depositAll()
      Deposits all of the given item from the players inventory into the bank.
      boolean depositFive()
      Deposits five of the given items from the players inventory into the bank.
      boolean depositOne()
      Deposits one of the given item from the players inventory into the bank.
      boolean depositTen()
      Deposits ten of the given items from the players inventory into the bank.
      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.
      • 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
      • depositOne

        public boolean depositOne()
        Deposits one of the given item from the players inventory into the bank.
        Returns:
        true if the deposit was successful and false otherwise.
      • depositFive

        public boolean depositFive()
        Deposits five of the given items from the players inventory into the bank.
        Returns:
        true if the deposit was successful and false otherwise.
      • depositTen

        public boolean depositTen()
        Deposits ten of the given items from the players inventory into the bank.
        Returns:
        true if the deposit was successful and false otherwise.
      • deposit

        public boolean deposit​(int amount)
        Deposits a set amount of the given item from the players inventory to the bank. If the amount is not one of: 1, 5, or 10 then all of the given item will be deposited by default.
        Parameters:
        amount - The amount of the item to deposit: 1, 5, 10, or any other integer for all of the item
        Returns:
        True if the deposit was successful and false otherwise
      • depositAll

        public boolean depositAll()
        Deposits all of the given item from the players inventory into the bank.
        Returns:
        True if the deposit was successful and false otherwise.