Package com.olziedev.playerauctions.api.player

Class AGUIPlayer

java.lang.Object
com.olziedev.playerauctions.api.player.AGUIPlayer
public abstract class AGUIPlayer extends Object
Handles and manages all the player data for the current open GUI.

  • Constructor Details

    • AGUIPlayer

      public AGUIPlayer()

  • Method Details

    • getAuctionPlayer

      public abstract APlayer getAuctionPlayer()
      Returns:
      The owner of this object.

    • getCategory

      public abstract ACategory getCategory()
      Returns:
      The cached category object.

    • setCategory

      public abstract void setCategory(ACategory category)
      Modifies the cached category in this object.
      Parameters:
      category - The cached category object.

    • getPage

      public abstract int getPage()
      Returns:
      The cached pages for the GUI.

    • getPages

      public abstract int getPages()
      Returns:
      The cached pages for the GUI.

    • getSearch

      public abstract String getSearch()
      Returns:
      The cached search for the GUI.

    • setSearch

      public abstract void setSearch(String search)
      Modifies the cached search in this object.
      Parameters:
      search - The cached search for the GUI.

    • getSortType

      public abstract AuctionSortType getSortType()
      Returns:
      The cached sort type for the GUI.

    • getPlayerAuction

      public abstract Auction getPlayerAuction()
      Returns:
      The cached auction in this object.

    • setPlayerAuction

      public abstract void setPlayerAuction(Auction playerAuction)
      Modifies the cached auction in this object.
      Parameters:
      playerAuction - The cached auction for the GUI.

    • notReady

      public abstract boolean notReady()
      Returns:
      If the GUI is not ready to receive a click from the player.

    • setReady

      public abstract void setReady(boolean isReady)
      Modifies if the GUI is ready to receive a click from the player.
      Parameters:
      isReady - If the GUI is ready.

    • getAmount

      public abstract Double getAmount()
      Returns:
      The cached amount in this object.

    • setAmount

      public abstract void setAmount(Double amount)
      Modifies the cached amount in this object.
      Parameters:
      amount - The cached amount for the GUI.

    • getRecentActionType

      public abstract RecentAuctionType getRecentActionType()
      Returns:
      The recent auction type in this object.

    • setRecentActionType

      public abstract void setRecentActionType(RecentAuctionType recentActionType)
      Modifies the previous inventory that the player opened.
      Parameters:
      recentActionType - The recent auction type for the GUI.

    • reset

      public abstract void reset()
      This will reset that this object is holding.

    • hasInventoryOpen

      public abstract boolean hasInventoryOpen()
      Returns:
      If the player has one of the plugins' menu open.