Package net.risingworld.api.events.player

Klasse PlayerKickEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.PlayerKickEvent
Alle implementierten Schnittstellen:
Cancellable
public final class PlayerKickEvent extends PlayerEvent implements Cancellable
Called when a player gets kicked.

  • Methodendetails

    • getSenderName

      public String getSenderName()
      Gets the name of the player who wants to kick this player. If the player was kicked through the API or Rcon, the name will be "API" or "RCON" accordingly
      Gibt zurück:
      the name of the "sender".

    • setReason

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

    • getReason

      public String getReason()
      Gets the reason why the player will be kicked.
      Gibt zurück:
      the kick reason (if one is set).

    • isCancelled

      public boolean isCancelled()
      Beschreibung aus Schnittstelle kopiert: 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.
      Angegeben von:
      isCancelled in Schnittstelle Cancellable
      Gibt zurück:
      true if the event is cancelled, or false if not.

    • setCancelled

      public void setCancelled(boolean cancel)
      Beschreibung aus Schnittstelle kopiert: Cancellable
      Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

      Angegeben von:
      setCancelled in Schnittstelle Cancellable
      Parameter:
      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}