Package org.bukkit.inventory.meta

Class BookMeta.Spigot

java.lang.Object
org.bukkit.inventory.meta.BookMeta.Spigot
Enclosing interface:
BookMeta
public static class BookMeta.Spigot extends Object

  • Constructor Summary Link icon

    Constructors
    Constructor
    Description
    Spigot()
     

  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    void
    addPage(net.md_5.bungee.api.chat.BaseComponent[]... pages)
    Adds new pages to the end of the book.
    net.md_5.bungee.api.chat.BaseComponent[]
    getPage(int page)
    Gets the specified page in the book.
    List<net.md_5.bungee.api.chat.BaseComponent[]>
    getPages()
    Gets all the pages in the book.
    void
    setPage(int page, net.md_5.bungee.api.chat.BaseComponent... data)
    Sets the specified page in the book.
    void
    setPages(List<net.md_5.bungee.api.chat.BaseComponent[]> pages)
    Clears the existing book pages, and sets the book to use the provided pages.
    void
    setPages(net.md_5.bungee.api.chat.BaseComponent[]... pages)
    Clears the existing book pages, and sets the book to use the provided pages.

    Methods inherited from class java.lang.Object Link icon

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details Link icon

    • Spigot Link icon

      public Spigot()

  • Method Details Link icon

    • getPage Link icon

      @NotNull public net.md_5.bungee.api.chat.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 Link icon

      public void setPage(int page, @Nullable net.md_5.bungee.api.chat.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 Link icon

      @NotNull public List<net.md_5.bungee.api.chat.BaseComponent[]> getPages()
      Gets all the pages in the book.
      Returns:
      list of all the pages in the book

    • setPages Link icon

      public void setPages(@NotNull List<net.md_5.bungee.api.chat.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 Link icon

      public void setPages(@NotNull net.md_5.bungee.api.chat.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 Link icon

      public void addPage(@NotNull net.md_5.bungee.api.chat.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