Package net.risingworld.api.events.general

Class InputEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.general.InputEvent
All Implemented Interfaces:
Cancellable
public final class InputEvent extends Event implements Cancellable
Triggered when an input command was received by the server process, or more precisely, an input command which was received from the System.in input stream.
The event is triggered before the server processes any built-in commands, so if you cancel the event, the server will not process the built-in input commands anymore.

This only works on dedicated servers!

  • Method Details

    • getInput

      public String getInput()

    • 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}