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 a Sign Change event is cancelled, the sign will not be changed.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.bukkit.event.Event

    Event.Result

  • Field Summary

    Fields inherited from class org.bukkit.event.block.BlockEvent

    block

  • Constructor Summary

    Constructors 
    Constructor Description
    SignChangeEvent​(Block theBlock, Player thePlayer, java.lang.String[] theLines)  

  • Method Summary

    Modifier and Type Method Description
    static HandlerList getHandlerList()  
    HandlerList getHandlers()  
    java.lang.String getLine​(int index)
    Gets a single line of text from the sign involved in this event.
    java.lang.String[] getLines()
    Gets all of the lines of text from the sign involved in this event.
    Player getPlayer()
    Gets the player changing the sign involved in this event.
    boolean isCancelled()
    Gets the cancellation state of this event.
    void setCancelled​(boolean cancel)
    Sets the cancellation state of this event.
    void setLine​(int index, java.lang.String line)
    Sets a single line for the sign involved in this event

    Methods inherited from class org.bukkit.event.block.BlockEvent

    getBlock

    Methods inherited from class org.bukkit.event.Event

    getEventName, isAsynchronous

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • getPlayer

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

    • getLines

      public java.lang.String[] getLines()
      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

      public java.lang.String getLine​(int index) throws java.lang.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:
      java.lang.IndexOutOfBoundsException - thrown when the provided index is > 3 or < 0

    • setLine

      public void setLine​(int index, java.lang.String line) throws java.lang.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:
      java.lang.IndexOutOfBoundsException - thrown when the provided index is > 3 or < 0

    • 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

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

    • getHandlerList

      public static HandlerList getHandlerList()