Package net.minestom.server.item.metadata

Class WrittenBookMeta

java.lang.Object
net.minestom.server.item.metadata.WrittenBookMeta
All Implemented Interfaces:
ItemMeta
public class WrittenBookMeta
extends java.lang.Object
implements ItemMeta

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  WrittenBookMeta.WrittenBookGeneration  

  • Constructor Summary

    Constructors 
    Constructor Description
    WrittenBookMeta()  

  • Method Summary

    Modifier and Type Method Description
    ItemMeta copy()
    Copies this item meta.
    java.lang.String getAuthor()
    Gets the author of the book.
    WrittenBookMeta.WrittenBookGeneration getGeneration()
    Gets the copy tier of the book.
    java.util.ArrayList<JsonMessage> getPages()
    Gets an ArrayList containing all the pages.
    java.lang.String getTitle()
    Gets the title of the book.
    boolean hasNbt()
    Gets if this meta object contains any useful data to send to the client.
    boolean isResolved()
    Gets if the book is resolved.
    boolean isSimilar​(ItemMeta itemMeta)
    Gets if the two ItemMeta are similar.
    void read​(org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
    Reads nbt data from a compound.
    void setAuthor​(java.lang.String author)
    Sets the author of the book.
    void setGeneration​(WrittenBookMeta.WrittenBookGeneration generation)
    Sets the copy tier of the book.
    void setPages​(java.util.ArrayList<JsonMessage> pages)
    Sets the ArrayList containing the book pages.
    void setResolved​(boolean resolved)
    Sets to true when the book (or a book from the stack) is opened for the first time after being created.
    void setTitle​(java.lang.String title)
    Sets the title of the book.
    void write​(org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
    Writes nbt data to a compound.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • isResolved

      public boolean isResolved()
      Gets if the book is resolved.
      Returns:
      true if the book is resolved, false otherwise

    • setResolved

      public void setResolved​(boolean resolved)
      Sets to true when the book (or a book from the stack) is opened for the first time after being created.
      Parameters:
      resolved - true to make the book resolved, false otherwise

    • getGeneration

      public WrittenBookMeta.WrittenBookGeneration getGeneration()
      Gets the copy tier of the book.
      Returns:
      the copy tier of the book

    • setGeneration

      public void setGeneration​(WrittenBookMeta.WrittenBookGeneration generation)
      Sets the copy tier of the book.
      Parameters:
      generation - the copy tier of the book

    • getAuthor

      public java.lang.String getAuthor()
      Gets the author of the book.
      Returns:
      the author of the book

    • setAuthor

      public void setAuthor​(java.lang.String author)
      Sets the author of the book.
      Parameters:
      author - the author of the book

    • getTitle

      public java.lang.String getTitle()
      Gets the title of the book.
      Returns:
      the title of the book

    • setTitle

      public void setTitle​(java.lang.String title)
      Sets the title of the book.
      Parameters:
      title - the title of the book

    • getPages

      public java.util.ArrayList<JsonMessage> getPages()
      Gets an ArrayList containing all the pages.

      The list is modifiable.

      Returns:
      a modifiable ArrayList with the pages of the book

    • setPages

      public void setPages​(java.util.ArrayList<JsonMessage> pages)
      Sets the ArrayList containing the book pages.
      Parameters:
      pages - the array list containing the book pages

    • hasNbt

      public boolean hasNbt()
      Description copied from interface: ItemMeta
      Gets if this meta object contains any useful data to send to the client.
      Specified by:
      hasNbt in interface ItemMeta
      Returns:
      true if this item has nbt data, false otherwise

    • isSimilar

      public boolean isSimilar​(@NotNull ItemMeta itemMeta)
      Description copied from interface: ItemMeta
      Gets if the two ItemMeta are similar.

      It is used by ItemStack.isSimilar(ItemStack).

      Specified by:
      isSimilar in interface ItemMeta
      Parameters:
      itemMeta - the second item meta to check
      Returns:
      true if the two meta are similar, false otherwise

    • read

      public void read​(@NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
      Description copied from interface: ItemMeta
      Reads nbt data from a compound.

      WARNING: it is possible that it contains no useful data, it has to be checked before getting anything.

      Specified by:
      read in interface ItemMeta
      Parameters:
      compound - the compound containing the data

    • write

      public void write​(@NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
      Description copied from interface: ItemMeta
      Writes nbt data to a compound.
      Specified by:
      write in interface ItemMeta
      Parameters:
      compound - the compound receiving the item meta data

    • copy

      @NotNull public ItemMeta copy()
      Description copied from interface: ItemMeta
      Copies this item meta.

      Used by ItemStack.copy().

      Specified by:
      copy in interface ItemMeta
      Returns:
      the cloned item meta