Class BookMeta.Spigot

java.lang.Object
org.bukkit.inventory.meta.BookMeta.Spigot
Enclosing interface:
BookMeta

public static class BookMeta.Spigot extends Object
  • Constructor Details

    • Spigot

      public Spigot()
  • Method Details

    • getPage

      @NotNull public BaseComponent[] getPage(int page)
      Gets the specified page in the book. The given page must exist.
      Parameters:
      page - the page number to get
      Returns:
      the page from the book
    • setPage

      public void setPage(int page, @Nullable BaseComponent... data)
      Sets the specified page in the book. Pages of the book must be contiguous.

      The data can be up to 256 characters in length, additional characters are truncated.

      Parameters:
      page - the page number to set
      data - the data to set for that page
    • getPages

      @NotNull public List<BaseComponent[]> getPages()
      Gets all the pages in the book.
      Returns:
      list of all the pages in the book
    • setPages

      public void setPages(@NotNull List<BaseComponent[]> pages)
      Clears the existing book pages, and sets the book to use the provided pages. Maximum 50 pages with 256 characters per page.
      Parameters:
      pages - A list of pages to set the book to use
    • setPages

      public void setPages(@NotNull BaseComponent[]... pages)
      Clears the existing book pages, and sets the book to use the provided pages. Maximum 50 pages with 256 characters per page.
      Parameters:
      pages - A list of component arrays, each being a page
    • addPage

      public void addPage(@NotNull BaseComponent[]... pages)
      Adds new pages to the end of the book. Up to a maximum of 50 pages with 256 characters per page.
      Parameters:
      pages - A list of component arrays, each being a page