Package com.olziedev.playerwarps.api.player

Class WGUIPlayer

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

  • Constructor Details

    • WGUIPlayer

      public WGUIPlayer()

  • Method Details

    • getWarpPlayer

      public abstract WPlayer getWarpPlayer()
      Returns:
      The owner of this object.

    • getCategory

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

    • setCategory

      public abstract void setCategory(WCategory 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 WarpSortType getSortType()
      Returns:
      The cached sort type for the GUI.

    • getPlayerWarp

      public abstract Warp getPlayerWarp()
      Returns:
      The cached warp in this object.

    • setPlayerWarp

      public abstract void setPlayerWarp(Warp playerWarp)
      Modifies the cached warp in this object.
      Parameters:
      playerWarp - The cached warp 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.

    • 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.