Package com.nickuc.chat.api.events

Class ProxyPrivateMessageEvent

java.lang.Object

org.bukkit.event.Event

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

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

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

com.nickuc.chat.api.events.ProxyPrivateMessageEvent

All Implemented Interfaces:

SpoofableEvent, org.bukkit.event.Cancellable

public class ProxyPrivateMessageEvent
extends MultiFragmentableMessageEvent<ProxyPrivateMessageEvent>
implements SpoofableEvent

Event triggered when a private message is received via proxy.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProxyPrivateMessageEvent.Type

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

org.bukkit.event.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ERR_NOT_AUTHENTICATED
static final int	ERR_PLAYER_IS_OFFLINE
static final int	ERR_TELL_DISABLED
static final int	ERR_TELL_IGNORED
static final int	STAGE_SENDER_PREPARING_MESSAGE	Sender to Target (preparation) Server: the same as the sender (server A). Available player instances: only the sender Available formats: target and spy. What is performed: translators are called to process internal tags.
static final int	STAGE_SENDER_TO_TARGET	Sender to Target (ready) Server: the same as the target (server B). Available player instances: only the target Available formats: target and spy. What is performed: translators are called to process the external tags.
static final int	STAGE_TARGET_PREPARING_MESSAGE	Target to Sender (preparation) Server: the same as the target (server B). Available player instances: only the target Available formats: sender and spy. What is performed: translators are called to process internal tags.
static final int	STAGE_TARGET_TO_SENDER	Target to Sender (ready) Server: the same as the sender (server A). Available player instances: only the sender Available formats: sender and spy. What is performed: translators are called to process the external tags.

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
ProxyPrivateMessageEvent(PrivateChannel privateChannel, UUID senderId, UUID targetId, String senderName, String targetName, String message, String serverName, int stage, String... formats)

Method Summary

Modifier and Type	Method	Description
static String[]	getBungeeTellFormats(PrivateChannel channel, int stage)	Deprecated. use getProxyTellFormats(PrivateChannel, int) instead
PrivateChannel	getChannel()	Gets the channel used in this event.
String	getFormat(ProxyPrivateMessageEvent.Type type)
Optional<MessagePiece>	getPiece(String tag, ProxyPrivateMessageEvent.Type type)
MessagePieceMap	getPieces(ProxyPrivateMessageEvent.Type type)
static String[]	getProxyTellFormats(PrivateChannel channel, int stage)
String	getSender()	Gets the player who produced this message.
String	getSenderFormat()	Gets the sender's format.
UUID	getSenderId()	Gets the UUID of the player who produced this message.
String	getServerName()	Gets the server name who produced this message.
String	getSpyFormat()	Gets the spy's format.
int	getStage()	Returns the stage of this message.
Optional<net.md_5.bungee.api.chat.TextComponent>	getTag(String tag, ProxyPrivateMessageEvent.Type type)	Deprecated. use getTagComponent(String, Type) instead
Optional<Component>	getTagComponent(String tag, ProxyPrivateMessageEvent.Type type)
net.md_5.bungee.api.chat.TextComponent	getTagValue(String tag, ProxyPrivateMessageEvent.Type type)	Deprecated. use getTagComponent(String, Type) instead
String	getTarget()	Gets the player who will receive this message.
String	getTargetFormat()	Gets the target's format.
UUID	getTargetId()	Gets the UUID of the player who will receive this message.
boolean	isSpoofSend()	Returns if spoof mode is being used in this event.
void	setFormat(String format, ProxyPrivateMessageEvent.Type type)
void	setSpoofSend()	Defines that spoof mode will be used in this event.
void	setTag(String tag, Component component, ProxyPrivateMessageEvent.Type type)
void	setTag(String tag, String content, ProxyPrivateMessageEvent.Type type)
void	setTag(String tag, net.md_5.bungee.api.chat.TextComponent component, ProxyPrivateMessageEvent.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

Field Details

STAGE_SENDER_PREPARING_MESSAGE

public static final int STAGE_SENDER_PREPARING_MESSAGE

Sender to Target (preparation)

• Server: the same as the sender (server A).
• Available player instances: only the sender
• Available formats: target and spy.
• What is performed: translators are called to process internal tags.

See Also:

• Constant Field Values

STAGE_SENDER_TO_TARGET

public static final int STAGE_SENDER_TO_TARGET

Sender to Target (ready)

• Server: the same as the target (server B).
• Available player instances: only the target
• Available formats: target and spy.
• What is performed: translators are called to process the external tags.

See Also:

• Constant Field Values

STAGE_TARGET_PREPARING_MESSAGE

public static final int STAGE_TARGET_PREPARING_MESSAGE

Target to Sender (preparation)

• Server: the same as the target (server B).
• Available player instances: only the target
• Available formats: sender and spy.
• What is performed: translators are called to process internal tags.

See Also:

• Constant Field Values

STAGE_TARGET_TO_SENDER

public static final int STAGE_TARGET_TO_SENDER

Target to Sender (ready)

• Server: the same as the sender (server A).
• Available player instances: only the sender
• Available formats: sender and spy.
• What is performed: translators are called to process the external tags.

See Also:

• Constant Field Values

ERR_PLAYER_IS_OFFLINE

public static final int ERR_PLAYER_IS_OFFLINE

See Also:

• Constant Field Values

ERR_TELL_DISABLED

public static final int ERR_TELL_DISABLED

See Also:

• Constant Field Values

ERR_TELL_IGNORED

public static final int ERR_TELL_IGNORED

See Also:

• Constant Field Values

ERR_NOT_AUTHENTICATED

public static final int ERR_NOT_AUTHENTICATED

See Also:

• Constant Field Values

Constructor Details

ProxyPrivateMessageEvent

public ProxyPrivateMessageEvent(@Nonnull
 PrivateChannel privateChannel,
 @Nonnull
 UUID senderId,
 @Nonnull
 UUID targetId,
 @Nonnull
 String senderName,
 @Nonnull
 String targetName,
 @Nonnull
 String message,
 String serverName,
 int stage,
 String... formats)

Method Details

getProxyTellFormats

public static String[] getProxyTellFormats(PrivateChannel channel,
 int stage)

getBungeeTellFormats

public static String[] getBungeeTellFormats(PrivateChannel channel,
 int stage)

Deprecated.

use getProxyTellFormats(PrivateChannel, int) instead

getSender

@Nonnull
public String getSender()

Gets the player who produced this message.

getTarget

@Nonnull
public String getTarget()

Gets the player who will receive this message.

getSenderId

@Nonnull
public UUID getSenderId()

Gets the UUID of the player who produced this message.

getTargetId

@Nonnull
public UUID getTargetId()

Gets the UUID of 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()

Gets the channel used in this event.

getStage

public int getStage()

Returns the stage of this message.

For more information, check out the ProxyPrivateMessageEvent class fields.

getServerName

@Nullable
public String getServerName()

Gets the server name who produced this message.

Returns:

null if getStage() is equal to STAGE_SENDER_PREPARING_MESSAGE

getSenderFormat

@Nonnull
public String getSenderFormat()
                       throws IllegalStateException

Gets the sender's format.

Throws:

IllegalArgumentException - if the getStage() does not support this method

IllegalStateException

getTargetFormat

@Nonnull
public String getTargetFormat()
                       throws IllegalStateException

Gets the target's format.

Throws:

IllegalArgumentException - if the getStage() does not support this method

IllegalStateException

getSpyFormat

@Nonnull
public String getSpyFormat()

Gets the spy's format.

getPiece

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

getPieces

@Nonnull
public MessagePieceMap getPieces(ProxyPrivateMessageEvent.Type type)

getTagComponent

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

getTag

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

Deprecated.

use getTagComponent(String, Type) instead

getTagValue

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

Deprecated.

use getTagComponent(String, Type) instead

setTag

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

setTag

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

Deprecated.

use setTag(String, Component, Type) instead

setTag

public void setTag(String tag,
 String content,
 ProxyPrivateMessageEvent.Type type)

getFormat

@Nonnull
public String getFormat(ProxyPrivateMessageEvent.Type type)

setFormat

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

toString

public String toString()

Overrides:

toString in class Object