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

Class PreChatEvent

java.lang.Object

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

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

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

All Implemented Interfaces:

CancellableEvent, ChatPluginEvent, ChatPluginPlayerEvent, ChatPluginServerPlayerEvent

public class PreChatEvent
extends PublicMessageEvent
implements CancellableEvent

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

Constructor Summary

Constructors

Constructor	Description
PreChatEvent(ChatPluginServerPlayer player, String message, ChatChannel<? extends ChatChannelData> channel)	Constructs a new pre chat 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.PublicMessageEvent

getChannel

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

getMessage, getPlayer

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

PreChatEvent

public PreChatEvent(ChatPluginServerPlayer player,
 String message,
 ChatChannel<? extends ChatChannelData> channel)

Constructs a new pre chat event.

Parameters:

player - Player involved

message - Message involved

channel - Channel 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