net.risingworld.api.events.player

Class PlayerKickEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerKickEvent

All Implemented Interfaces:

Cancellable

public class PlayerKickEvent
extends PlayerEvent
implements Cancellable

Called when a player gets kicked.

Constructor Summary

Constructors

Constructor and Description
PlayerKickEvent(Player player, java.lang.String sendername, java.lang.String reason)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getReason() Gets the reason why the player will be kicked.
java.lang.String	getSenderName() Gets the name of the player who wants to kick this player.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setReason(java.lang.String reason) Sets the reason why this player will be kicked.

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

PlayerKickEvent

public PlayerKickEvent(Player player,
                       java.lang.String sendername,
                       java.lang.String reason)

Method Detail

getSenderName

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

Returns:

the name of the "sender".

setReason

public void setReason(java.lang.String reason)

Sets the reason why this player will be kicked. This message will be displayed to the kicked player.

Parameters:

reason - the reason why the player will be kicked.

getReason

public java.lang.String getReason()

Gets the reason why the player will be kicked.

Returns:

the kick reason (if one is set).

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.