Package org.bukkit.event.block

Class SignChangeEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.block.BlockEvent
org.bukkit.event.block.SignChangeEvent
All Implemented Interfaces:
Cancellable
public class SignChangeEvent extends BlockEvent implements Cancellable
Called when a sign is changed by a player.

If this event is cancelled, the sign will not be changed.

  • Constructor Details

    • SignChangeEvent

      @Internal public SignChangeEvent(@NotNull @NotNull Block sign, @NotNull @NotNull Player player, @NotNull List<Component> adventure$lines, @NotNull @NotNull Side side)

    • SignChangeEvent

      @Internal @Deprecated(forRemoval=true) public SignChangeEvent(@NotNull @NotNull Block sign, @NotNull @NotNull Player player, @NotNull List<Component> adventure$lines)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • SignChangeEvent

      @Internal @Deprecated(since="1.19.4", forRemoval=true) public SignChangeEvent(@NotNull @NotNull Block sign, @NotNull @NotNull Player thePlayer, @NotNull @NotNull String[] theLines)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • SignChangeEvent

      @Internal @Deprecated(forRemoval=true) public SignChangeEvent(@NotNull @NotNull Block sign, @NotNull @NotNull Player thePlayer, @NotNull @NotNull String[] theLines, @NotNull @NotNull Side side)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getPlayer

      @NotNull public @NotNull Player getPlayer()
      Gets the player changing the sign involved in this event.
      Returns:
      the Player involved in this event

    • lines

      @NotNull public List<Component> lines()
      Gets all of the lines of text from the sign involved in this event.
      Returns:
      the String array for the sign's lines new text

    • line

      public @Nullable Component line(int index) throws IndexOutOfBoundsException
      Gets a single line of text from the sign involved in this event.
      Parameters:
      index - index of the line to get
      Returns:
      the String containing the line of text associated with the provided index
      Throws:
      IndexOutOfBoundsException - thrown when the provided index is > 3 or < 0

    • line

      public void line(int index, @Nullable Component line) throws IndexOutOfBoundsException
      Sets a single line for the sign involved in this event
      Parameters:
      index - index of the line to set
      line - text to set
      Throws:
      IndexOutOfBoundsException - thrown when the provided index is > 3 or < 0

    • getLines

      @NotNull @Deprecated public @NotNull String[] getLines()
      Deprecated.
      in favour of lines()
      Gets all of the lines of text from the sign involved in this event.
      Returns:
      the String array for the sign's lines new text

    • getLine

      @Nullable @Deprecated public @Nullable String getLine(int index) throws IndexOutOfBoundsException
      Deprecated.
      in favour of line(int)
      Gets a single line of text from the sign involved in this event.
      Parameters:
      index - index of the line to get
      Returns:
      the String containing the line of text associated with the provided index
      Throws:
      IndexOutOfBoundsException - thrown when the provided index is > 3 or < 0

    • setLine

      @Deprecated public void setLine(int index, @Nullable @Nullable String line) throws IndexOutOfBoundsException
      Deprecated.
      in favour of line(int, net.kyori.adventure.text.Component)
      Sets a single line for the sign involved in this event
      Parameters:
      index - index of the line to set
      line - text to set
      Throws:
      IndexOutOfBoundsException - thrown when the provided index is > 3 or < 0

    • getSide

      @NotNull public @NotNull Side getSide()
      Returns which side is changed.
      Returns:
      the affected side of the sign

    • 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

    • getHandlers

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

    • getHandlerList

      @NotNull public static @NotNull HandlerList getHandlerList()