Package net.gcnt.additionsplus.api.managers

Interface CustomMenuManager

All Superinterfaces:
AdditionsSubMenu
public interface CustomMenuManager extends AdditionsSubMenu
Manager for custom menu setups and editing.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addManagingItems(org.bukkit.entity.Player player)
    Add the custom menu managing items to the player's inventory.
    void
    discard(org.bukkit.entity.Player player)
    Discard the current custom menu of a player.
    void
    dontRestore(org.bukkit.entity.Player player, boolean restore)
    Adds a player to the do-not-restore inventory list.
    HashMap<org.bukkit.entity.Player,Boolean>
    getEditingMenus()
    Get a list of players that are currently setting up/editing a custom menu.
    org.bukkit.inventory.Inventory
    getMenu(org.bukkit.entity.Player player)
    Get the custom menu inventory that the player is editing.
    HashMap<UUID,String>
    getMenuTitles()
    Get a HashMap of player UUID and their custom menu titles.
    boolean
    hasMenu(org.bukkit.entity.Player player)
    Check whether a player has a custom menu set up.
    boolean
    isEditingMenu(org.bukkit.entity.Player player)
    Get whether a player is currently editing a custom menu.
    void
    restoreInventory(org.bukkit.entity.Player player)
    Restore the original inventory of the player.
    void
    saveMenu(org.bukkit.entity.Player player)
    Save the current menu inventory that the player is working on.
    void
    saveMenu(org.bukkit.entity.Player player, org.bukkit.inventory.Inventory inventory)
    Save the current menu inventory that the player is working on.
    void
    setEditingMenu(org.bukkit.entity.Player player, boolean editing)
    Set whether a player is currently editing a custom menu.
    void
    storeInventory(org.bukkit.entity.Player player)
    Store the player's current inventory.

    Methods inherited from interface net.gcnt.additionsplus.api.utils.AdditionsSubMenu

    openMenu, openMenu

  • Method Details

    • discard

      void discard(org.bukkit.entity.Player player)
      Discard the current custom menu of a player. This cannot be undone.
      Parameters:
      player - Player to discard setup of.

    • getMenu

      org.bukkit.inventory.Inventory getMenu(org.bukkit.entity.Player player)
      Get the custom menu inventory that the player is editing.
      Parameters:
      player - Player to check.
      Returns:
      Inventory when found, null otherwise.

    • storeInventory

      void storeInventory(org.bukkit.entity.Player player)
      Store the player's current inventory.
      Parameters:
      player - Player to save inventory of.

    • addManagingItems

      void addManagingItems(org.bukkit.entity.Player player)
      Add the custom menu managing items to the player's inventory.
      Parameters:
      player - Player to add items to.

    • restoreInventory

      void restoreInventory(org.bukkit.entity.Player player)
      Restore the original inventory of the player.
      Parameters:
      player - Player to restore.

    • saveMenu

      void saveMenu(org.bukkit.entity.Player player)
      Save the current menu inventory that the player is working on.
      Parameters:
      player - Player to save.

    • saveMenu

      void saveMenu(org.bukkit.entity.Player player, org.bukkit.inventory.Inventory inventory)
      Save the current menu inventory that the player is working on.
      Parameters:
      player - Player to save.
      inventory - Inventory to save.

    • hasMenu

      boolean hasMenu(org.bukkit.entity.Player player)
      Check whether a player has a custom menu set up.
      Parameters:
      player - Player to check.
      Returns:
      True when menu found, false otherwise.

    • setEditingMenu

      void setEditingMenu(org.bukkit.entity.Player player, boolean editing)
      Set whether a player is currently editing a custom menu.
      Parameters:
      player - Player to check.
      editing - Whether the player is editing.

    • isEditingMenu

      boolean isEditingMenu(org.bukkit.entity.Player player)
      Get whether a player is currently editing a custom menu.
      Parameters:
      player - Player to check.
      Returns:
      True when editing, false otherwise.

    • dontRestore

      void dontRestore(org.bukkit.entity.Player player, boolean restore)
      Adds a player to the do-not-restore inventory list.
      Parameters:
      player - Player to add.
      restore - Whether to restore or not.

    • getEditingMenus

      HashMap<org.bukkit.entity.Player,Boolean> getEditingMenus()
      Get a list of players that are currently setting up/editing a custom menu.
      Returns:
      List of players that are editing custom menus.

    • getMenuTitles

      HashMap<UUID,String> getMenuTitles()
      Get a HashMap of player UUID and their custom menu titles.
      Returns:
      HashMap of player UUID and their custom menu titles.