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 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:

PlayerSpawnEvent, PlayerDisconnectEvent

Constructor Summary

Constructors

Constructor and Description
PlayerConnectEvent(Player player, boolean newPlayer)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisconnectReason() Gets the reason why the player will be disconnected.
boolean	isCancelled() Determines if the event is cancelled.
boolean	isNewPlayer() Gets whether or not this is a new player, i.e. this is the first time this player connects to this server.
void	setCancelled(boolean cancel) Cancels this event.
void	setDisconnectReason(java.lang.String reason) If you cancel the event, the player will be disconnected from the server.

Methods inherited from class net.risingworld.api.events.player.PlayerEvent

getPlayer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlayerConnectEvent

public PlayerConnectEvent(Player player,
                          boolean newPlayer)

Method Detail

setDisconnectReason

public void setDisconnectReason(java.lang.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 was disconnected.

getDisconnectReason

public java.lang.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 an empty string 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.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.