Package com.velocitypowered.api.event.connection

Class PluginMessageEvent

java.lang.Object

com.velocitypowered.api.event.connection.PluginMessageEvent

All Implemented Interfaces:

ResultedEvent<PluginMessageEvent.ForwardResult>

@AwaitingEvent
public final class PluginMessageEvent
extends Object
implements ResultedEvent<PluginMessageEvent.ForwardResult>

This event is fired when a plugin message is sent to the proxy, either from a client (Player) or a server (ServerConnection). Velocity will wait on this event to finish firing before discarding the sent plugin message (if handled) or forwarding it to the server.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PluginMessageEvent.ForwardResult	A result determining whether or not to forward this message on.

Nested classes/interfaces inherited from interface com.velocitypowered.api.event.ResultedEvent

ResultedEvent.ComponentResult, ResultedEvent.GenericResult, ResultedEvent.Result

Constructor Summary

Constructors

Constructor	Description
PluginMessageEvent(ChannelMessageSource source, ChannelMessageSink target, ChannelIdentifier identifier, byte[] data)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
ByteArrayDataInput	dataAsDataStream()	Returns the plugin message payload as a ByteArrayDataInput.
ByteArrayInputStream	dataAsInputStream()	Returns the plugin message payload as a ByteArrayInputStream.
byte[]	getData()	Gets the raw payload of the plugin message.
ChannelIdentifier	getIdentifier()	Gets the channel identifier this message was sent on.
PluginMessageEvent.ForwardResult	getResult()	Returns the result associated with this event.
ChannelMessageSource	getSource()	Gets the source that sent this plugin message (a Player or ServerConnection).
ChannelMessageSink	getTarget()	Gets the target recipient of this plugin message.
void	setResult(PluginMessageEvent.ForwardResult result)	Sets the result of this event.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PluginMessageEvent

public PluginMessageEvent(ChannelMessageSource source,
 ChannelMessageSink target,
 ChannelIdentifier identifier,
 byte[] data)

Creates a new instance.

Parameters:

source - the source of the plugin message

target - the destination of the plugin message

identifier - the channel for this plugin message

data - the payload of the plugin message

Method Details

getResult

public PluginMessageEvent.ForwardResult getResult()

Description copied from interface: ResultedEvent

Returns the result associated with this event.

Specified by:

getResult in interface ResultedEvent<PluginMessageEvent.ForwardResult>

Returns:

the result of this event

setResult

public void setResult(PluginMessageEvent.ForwardResult result)

Description copied from interface: ResultedEvent

Sets the result of this event. The result must be non-null.

Specified by:

setResult in interface ResultedEvent<PluginMessageEvent.ForwardResult>

Parameters:

result - the new result

getSource

public ChannelMessageSource getSource()

Gets the source that sent this plugin message (a Player or ServerConnection).

Returns:

the message source

getTarget

public ChannelMessageSink getTarget()

Gets the target recipient of this plugin message.

Returns:

the message sink

getIdentifier

public ChannelIdentifier getIdentifier()

Gets the channel identifier this message was sent on.

Returns:

the plugin message identifier

getData

public byte[] getData()

Gets the raw payload of the plugin message.

Returns:

a copy of the message data

dataAsInputStream

public ByteArrayInputStream dataAsInputStream()

Returns the plugin message payload as a ByteArrayInputStream.

Returns:

the input stream wrapping the data

dataAsDataStream

public ByteArrayDataInput dataAsDataStream()

Returns the plugin message payload as a ByteArrayDataInput.

Returns:

the data input stream for reading structured data

toString

public String toString()

Overrides:

toString in class Object