Package net.risingworld.api.events.player

Class PlayerSetSignTextEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.PlayerSetSignTextEvent
All Implemented Interfaces:
Cancellable
public final class PlayerSetSignTextEvent extends PlayerEvent implements Cancellable
Called when a player changes the text on a sign.

  • Method Details

    • getSignID

      public long getSignID()
      Gets the related sign ID.
      Returns:
      the ID of the sign the player wants to set the text for.

    • getSign

      public Sign getSign()
      Gets the related sign object.
      Returns:
      the sign object (the player wants to set the text for).

    • getText

      public String getText()
      Gets the text the player wants to set for this sign.
      Returns:
      the text the player wants to set.

    • setText

      public void setText(String text)
      Sets a new text you want to be set for the sign.
      Parameters:
      text - the text you want to set.

    • getFont

      public Font getFont()
      Gets the font the player wants to set for this sign.
      Returns:
      the font.

    • setFont

      public void setFont(Font font)
      Sets the font for this sign.
      Parameters:
      font - the new font.

    • getFontSize

      public float getFontSize()
      Gets the font size the player wants to set for the sign. By default it's 1.0
      Returns:
      the font size of the sign.

    • setFontSize

      public void setFontSize(float size)
      Sets a new font size for the sign.
      Parameters:
      size - the new font size.

    • isCancelled

      public boolean isCancelled()
      Description copied from interface: Cancellable
      Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

      Please note: If the event is threaded, cancellation has no effect, i.e the event will still be executed.
      Specified by:
      isCancelled in interface Cancellable
      Returns:
      true if the event is cancelled, or false if not.

    • setCancelled

      public void setCancelled(boolean cancel)
      Description copied from interface: Cancellable
      Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

      Specified by:
      setCancelled in interface Cancellable
      Parameters:
      cancel - set to true if you want to cancel this event.
      Example: Cancel "PlayerEnterAreaEvent", i.e prevent player from entering an area
      1//Listener class
      2public class PlayerListener implements Listener{
      3 @EventMethod
      4 public void onEnterArea(PlayerEnterAreaEvent evt){
      5 //Now the player will not be able to enter the area, i.e.
      6 //he will be teleported back to his old position (outside the area)
      7 evt.setCancelled(true);
      8 }
      9}