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 class PlayerBanEvent
extends PlayerEvent
implements Cancellable

Called when a player gets banned.

Constructor Summary

Constructors

Constructor and Description
PlayerBanEvent(Player player, java.lang.String sendername, int duration, java.lang.String reason)

Method Summary

Modifier and Type	Method and Description
int	getDuration() Gets the duration (minutes) how long the player will be banned.
java.lang.String	getReason() Gets the reason why the player will be banned.
java.lang.String	getSenderName() Gets the name of the player who wants to ban this player.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setDuration(int duration) Sets the duration (minutes) how long the player will be banned.
void	setReason(java.lang.String reason) Sets the reason why this player will be banned.

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

PlayerBanEvent

public PlayerBanEvent(Player player,
                      java.lang.String sendername,
                      int duration,
                      java.lang.String reason)

Method Detail

getSenderName

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

setDuration

public void setDuration(int duration)

Sets the duration (minutes) how long the player will be banned. Use '-1' to ban the player permanently.

Parameters:

duration - the duration (minutes) how long the player will be banned.

getDuration

public int getDuration()

Gets the duration (minutes) how long the player will be banned. If the duration is set to '-1', the player will be banned permanently.

Returns:

the duration (minutes) how long the player will be banned, or -1 if he will be banned permanently.

setReason

public void setReason(java.lang.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 java.lang.String getReason()

Gets the reason why the player will be banned.

Returns:

the ban 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.