Package com.nickuc.chat.api.events

Class VirtualMessageEvent

java.lang.Object

org.bukkit.event.Event

com.nickuc.chat.api.events.internal.nChatEvent

com.nickuc.chat.api.events.internal.MessageEvent<VirtualMessageEvent>

com.nickuc.chat.api.events.VirtualMessageEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class VirtualMessageEvent
extends MessageEvent<VirtualMessageEvent>

Event triggered when a virtual message is sent.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Field Summary

Fields inherited from class com.nickuc.chat.api.events.internal.MessageEvent

recipients

Fields inherited from class com.nickuc.chat.api.events.internal.nChatEvent

cancelled, start

Constructor Summary

Constructors

Constructor	Description
VirtualMessageEvent(PublicChannel publicChannel, String format, String senderName, boolean highlight)

Method Summary

Modifier and Type	Method	Description
PublicChannel	getChannel()	Gets the channel involved in this event.
String	getFormat()	Gets the message format.
String	getSender()	Gets the name of the player who produced this message.
boolean	isHighlight()	Gets if highlight mode is being used in this event.
String	toString()

Methods inherited from class com.nickuc.chat.api.events.internal.MessageEvent

getRecipients, setRecipients

Methods inherited from class com.nickuc.chat.api.events.internal.nChatEvent

getHandlers

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bukkit.event.Cancellable

isCancelled, setCancelled

Constructor Details

VirtualMessageEvent

public VirtualMessageEvent(@Nonnull
 PublicChannel publicChannel,
 @Nonnull
 String format,
 @Nullable
 String senderName,
 boolean highlight)

Method Details

getChannel

@Nonnull
public PublicChannel getChannel()

Gets the channel involved in this event.

getSender

@Nullable
public String getSender()

Gets the name of the player who produced this message.

getFormat

@Nonnull
public String getFormat()

Gets the message format.

isHighlight

public boolean isHighlight()

Gets if highlight mode is being used in this event.

Returns:

true if highlighting is being used

toString

public String toString()

Overrides:

toString in class Object