Package me.remigio07.chatplugin.api.server.event.chat

Class PrePrivateMessageEvent

java.lang.Object

me.remigio07.chatplugin.api.server.event.chat.PrivateMessageEvent

me.remigio07.chatplugin.api.server.event.chat.PrePrivateMessageEvent

All Implemented Interfaces:

CancellableEvent, ChatPluginEvent, ChatPluginPlayerEvent, ChatPluginServerPlayerEvent

public class PrePrivateMessageEvent
extends PrivateMessageEvent
implements CancellableEvent

Represents an event called before a player's private message gets processed.

See Also:

• PrivateMessagesManager.sendPrivateMessage(ChatPluginServerPlayer, OfflinePlayer, String)
• PrivateMessagesManager.sendReply(ChatPluginServerPlayer, String)

Constructor Summary

Constructors

Constructor	Description
PrePrivateMessageEvent(ChatPluginServerPlayer player, OfflinePlayer recipient, String privateMessage)	Constructs a new pre private message event.

Method Summary

Modifier and Type	Method	Description
boolean	isCancelled()	Checks if this event has been cancelled and will not be executed.
void	setCancelled(boolean cancelled)	Sets the cancellation state of this event.

Methods inherited from class me.remigio07.chatplugin.api.server.event.chat.PrivateMessageEvent

getPlayer, getPrivateMessage, getRecipient

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.remigio07.chatplugin.api.common.event.ChatPluginEvent

call

Constructor Details

PrePrivateMessageEvent

public PrePrivateMessageEvent(ChatPluginServerPlayer player,
 OfflinePlayer recipient,
 String privateMessage)

Constructs a new pre private message event.

Specify null as either the sender or the recipient to indicate the console.

Parameters:

player - Player involved

recipient - Recipient involved

privateMessage - Private message involved

Method Details

isCancelled

public boolean isCancelled()

Description copied from interface: CancellableEvent

Checks if this event has been cancelled and will not be executed.

Specified by:

isCancelled in interface CancellableEvent

Returns:

Whether this event is cancelled

setCancelled

public void setCancelled(boolean cancelled)

Description copied from interface: CancellableEvent

Sets the cancellation state of this event.

It will be passed through other registered listeners even if it is cancelled, but it will not be executed.

Specified by:

setCancelled in interface CancellableEvent

Parameters:

cancelled - Whether this event should be cancelled