Package com.nickuc.chat.api.events

Class PrivateMessageEvent

java.lang.Object

org.bukkit.event.Event

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

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

com.nickuc.chat.api.events.internal.MultiFragmentableMessageEvent<PrivateMessageEvent>

com.nickuc.chat.api.events.PrivateMessageEvent

All Implemented Interfaces:

SpoofableEvent, org.bukkit.event.Cancellable

public class PrivateMessageEvent
extends MultiFragmentableMessageEvent<PrivateMessageEvent>
implements SpoofableEvent

Event triggered when a private message is sent.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PrivateMessageEvent.Type

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.MultiFragmentableMessageEvent

pieces

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
PrivateMessageEvent(PrivateChannel senderChannel, PrivateChannel targetChannel, org.bukkit.entity.Player sender, org.bukkit.entity.Player target, String message)

Method Summary

Modifier and Type	Method	Description
PrivateChannel	getChannel()	Deprecated. use getSenderChannel() and getTargetChannel() instead
String	getFormat(PrivateMessageEvent.Type type)
Optional<MessagePiece>	getPiece(String tag, PrivateMessageEvent.Type type)
MessagePieceMap	getPieces(PrivateMessageEvent.Type type)
org.bukkit.entity.Player	getSender()	Gets the player who produced this message.
PrivateChannel	getSenderChannel()	Gets the sender's channel used in this event.
String	getSenderFormat()	Gets the sender's format.
String	getSpyFormat()	Returns the spy's format.
Optional<net.md_5.bungee.api.chat.TextComponent>	getTag(String tag, PrivateMessageEvent.Type type)	Deprecated. use getTagComponent(String, Type) instead
Optional<Component>	getTagComponent(String tag, PrivateMessageEvent.Type type)
net.md_5.bungee.api.chat.TextComponent	getTagValue(String tag, PrivateMessageEvent.Type type)	Deprecated. use getTagComponent(String, Type) instead
org.bukkit.entity.Player	getTarget()	Gets the player who will receive this message.
PrivateChannel	getTargetChannel()	Gets the target's channel used in this event.
String	getTargetFormat()	Gets the target's format.
boolean	isSpoofSend()	Returns if spoof mode is being used in this event.
void	setFormat(String format, PrivateMessageEvent.Type type)
void	setSpoofSend()	Defines that spoof mode will be used in this event.
void	setTag(String tag, Component component, PrivateMessageEvent.Type type)
PrivateMessageEvent	setTag(String tag, String content, PrivateMessageEvent.Type type)
PrivateMessageEvent	setTag(String tag, net.md_5.bungee.api.chat.TextComponent component, PrivateMessageEvent.Type type)	Deprecated. use setTag(String, Component, Type) instead
String	toString()

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

getFormat, getMessage, getOriginalMessage, getPiece, getPieces, getTag, getTags, setFormat, setMessage, setTag, setTag

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

PrivateMessageEvent

public PrivateMessageEvent(@Nonnull
 PrivateChannel senderChannel,
 @Nonnull
 PrivateChannel targetChannel,
 @Nonnull
 org.bukkit.entity.Player sender,
 @Nonnull
 org.bukkit.entity.Player target,
 @Nonnull
 String message)

Method Details

getSender

@Nonnull
public org.bukkit.entity.Player getSender()

Gets the player who produced this message.

getTarget

@Nonnull
public org.bukkit.entity.Player getTarget()

Gets the player who will receive this message.

isSpoofSend

public boolean isSpoofSend()

Returns if spoof mode is being used in this event.

Specified by:

isSpoofSend in interface SpoofableEvent

Returns:

true if spoof mode is being used

setSpoofSend

public void setSpoofSend()

Defines that spoof mode will be used in this event.

Specified by:

setSpoofSend in interface SpoofableEvent

getChannel

@Nonnull
public PrivateChannel getChannel()

Deprecated.

use getSenderChannel() and getTargetChannel() instead

getSenderChannel

@Nonnull
public PrivateChannel getSenderChannel()

Gets the sender's channel used in this event.

getTargetChannel

@Nonnull
public PrivateChannel getTargetChannel()

Gets the target's channel used in this event.

getSenderFormat

@Nonnull
public String getSenderFormat()

Gets the sender's format.

This format is determined by the target (who receives).

getTargetFormat

@Nonnull
public String getTargetFormat()

Gets the target's format.

This format is determined by the sender (who sends).

getSpyFormat

@Nonnull
public String getSpyFormat()

Returns the spy's format.

getPiece

public Optional<MessagePiece> getPiece(String tag,
 PrivateMessageEvent.Type type)

getPieces

@Nonnull
public MessagePieceMap getPieces(PrivateMessageEvent.Type type)

getTagComponent

public Optional<Component> getTagComponent(String tag,
 PrivateMessageEvent.Type type)

getTag

public Optional<net.md_5.bungee.api.chat.TextComponent> getTag(String tag,
 PrivateMessageEvent.Type type)

Deprecated.

use getTagComponent(String, Type) instead

getTagValue

@Nonnull
public net.md_5.bungee.api.chat.TextComponent getTagValue(String tag,
 PrivateMessageEvent.Type type)

Deprecated.

use getTagComponent(String, Type) instead

setTag

public void setTag(String tag,
 Component component,
 PrivateMessageEvent.Type type)

setTag

public PrivateMessageEvent setTag(String tag,
 net.md_5.bungee.api.chat.TextComponent component,
 PrivateMessageEvent.Type type)

Deprecated.

use setTag(String, Component, Type) instead

setTag

public PrivateMessageEvent setTag(String tag,
 String content,
 PrivateMessageEvent.Type type)

getFormat

@Nonnull
public String getFormat(PrivateMessageEvent.Type type)

setFormat

public void setFormat(String format,
 PrivateMessageEvent.Type type)

toString

public String toString()

Overrides:

toString in class Object