Package net.risingworld.api.events.player

Class PlayerBanEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.PlayerBanEvent
All Implemented Interfaces:
Cancellable
public final class PlayerBanEvent extends PlayerEvent implements Cancellable
Called when a player gets banned.

  • Method Details

    • getSenderName

      public String getSenderName()
      Gets the name of the player who wants to ban this player. If the player was banned through the API or Rcon, the name will be "API" or "RCON" accordingly
      Returns:
      the name of the "sender".

    • setReason

      public void setReason(String reason)
      Sets the reason why this player will be banned. This message will be displayed to the banned player.
      Parameters:
      reason - the reason why the player will be banned.

    • getReason

      public String getReason()
      Gets the reason why the player will be banned.
      Returns:
      the ban reason (if one is set).

    • setDuration

      public void setDuration(int duration)
      Sets the duration (seconds) how long the player will be banned. Use '-1' to ban the player permanently.
      Parameters:
      duration - the duration (seconds) how long the player will be banned.

    • getDuration

      public int getDuration()
      Gets the duration (seconds) how long the player will be banned. If the duration is set to '-1', the player will be banned permanently.
      Returns:
      the duration (seconds) how long the player will be banned, or -1 if he will be banned permanently.

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