net.risingworld.api.events.player

Class PlayerPrivateMessageEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerPrivateMessageEvent

All Implemented Interfaces:

Cancellable

public final class PlayerPrivateMessageEvent
extends PlayerEvent
implements Cancellable

Called when a player sends a private message to another player. However, the content of the message is still private and cannot be retrieved by this event.

See Also:

PlayerChatEvent

Constructor Summary

Constructors

Constructor and Description
PlayerPrivateMessageEvent(Player player, Player targetPlayer)

Method Summary

Modifier and Type	Method and Description
Player	getTargetPlayer() Gets the recipient of the message.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.

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

PlayerPrivateMessageEvent

public PlayerPrivateMessageEvent(Player player,
                                 Player targetPlayer)

Method Detail

getTargetPlayer

public Player getTargetPlayer()

Gets the recipient of the message.

Returns:

the recipient player.

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.