Package net.risingworld.api.events.player

Class PlayerConnectEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.PlayerConnectEvent
All Implemented Interfaces:
Cancellable
public final class PlayerConnectEvent extends PlayerEvent implements Cancellable
Called when a player connects to the server. The event is called when the connection is established. At this time, the player still sees the loading screen, so if you send a message to the player at that stage, he will not see it. Instead, you can use the PlayerSpawnEvent.
See Also:

  • Method Details

    • setDisconnectReason

      public void setDisconnectReason(String reason)
      If you cancel the event, the player will be disconnected from the server. If a "disconnect reason" is set, this reason will be displayed on the player's screen. By default, no reason is set. If you don't have any intentions to cancel this event, this method basically does nothing (so you can ignore it).
      Parameters:
      reason - the reason why the player will be disconnected.

    • getDisconnectReason

      public String getDisconnectReason()
      Gets the reason why the player will be disconnected. This is only relevant if a disconnect reason was set by any plugin and the event will be cancelled.
      Returns:
      the disconnect reason (if one is set), otherwise null will be returned

    • isNewPlayer

      public boolean isNewPlayer()
      Gets whether or not this is a new player, i.e this is the first time this player connects to this server.
      Returns:
      true if it is a new player, false if not.

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