Package org.bukkit.event.player

Class PlayerEditBookEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerEditBookEvent
All Implemented Interfaces:
Cancellable
public class PlayerEditBookEvent
extends PlayerEvent
implements Cancellable
Called when a player edits or signs a book and quill item. If the event is cancelled, no changes are made to the BookMeta

  • Constructor Details

  • Method Details

    • getPreviousBookMeta

      @NotNull public BookMeta getPreviousBookMeta()
      Gets the book meta currently on the book.

      Note: this is a copy of the book meta. You cannot use this object to change the existing book meta.

      Returns:
      the book meta currently on the book

    • getNewBookMeta

      @NotNull public BookMeta getNewBookMeta()
      Gets the book meta that the player is attempting to add to the book.

      Note: this is a copy of the proposed new book meta. Use setNewBookMeta(BookMeta) to change what will actually be added to the book.

      Returns:
      the book meta that the player is attempting to add

    • getSlot

      @Deprecated public int getSlot()
      Deprecated.
      books may be signed from off hand
      Gets the inventory slot number for the book item that triggered this event.

      This is a slot number on the player's hotbar in the range 0-8, or -1 for off hand.

      Returns:
      the inventory slot number that the book item occupies

    • setNewBookMeta

      public void setNewBookMeta​(@NotNull BookMeta newBookMeta) throws IllegalArgumentException
      Sets the book meta that will actually be added to the book.
      Parameters:
      newBookMeta - new book meta
      Throws:
      IllegalArgumentException - if the new book meta is null

    • isSigning

      public boolean isSigning()
      Gets whether or not the book is being signed. If a book is signed the Material changes from BOOK_AND_QUILL to WRITTEN_BOOK.
      Returns:
      true if the book is being signed

    • setSigning

      public void setSigning​(boolean signing)
      Sets whether or not the book is being signed. If a book is signed the Material changes from BOOK_AND_QUILL to WRITTEN_BOOK.
      Parameters:
      signing - whether or not the book is being signed.

    • getHandlers

      @NotNull public HandlerList getHandlers()
      Specified by:
      getHandlers in class Event

    • getHandlerList

      @NotNull public static HandlerList getHandlerList()

    • isCancelled

      public boolean isCancelled()
      Description copied from interface: Cancellable
      Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins
      Specified by:
      isCancelled in interface Cancellable
      Returns:
      true if this event is cancelled

    • setCancelled

      public void setCancelled​(boolean cancel)
      Description copied from interface: Cancellable
      Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
      Specified by:
      setCancelled in interface Cancellable
      Parameters:
      cancel - true if you wish to cancel this event