Package com.velocitypowered.api.event.player

Class ServerLoginPluginMessageEvent

java.lang.Object

com.velocitypowered.api.event.player.ServerLoginPluginMessageEvent

All Implemented Interfaces:

ResultedEvent<ServerLoginPluginMessageEvent.ResponseResult>

@AwaitingEvent
public class ServerLoginPluginMessageEvent
extends Object
implements ResultedEvent<ServerLoginPluginMessageEvent.ResponseResult>

Fired when a server sends a login plugin message to the proxy. Plugins have the opportunity to respond to the messages as needed. Velocity will wait on this event to finish. The server will be responsible for continuing the login process once the server is satisfied with any login plugin responses sent by proxy plugins (or messages indicating a lack of response).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ServerLoginPluginMessageEvent.ResponseResult	The result class, containing a response to the login plugin message sent by the server.

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

ResultedEvent.ComponentResult, ResultedEvent.GenericResult, ResultedEvent.Result

Constructor Summary

Constructors

Constructor	Description
ServerLoginPluginMessageEvent(ServerConnection connection, ChannelIdentifier identifier, byte[] contents, int sequenceId)	Constructs a new ServerLoginPluginMessageEvent.

Method Summary

Modifier and Type	Method	Description
ByteArrayDataInput	contentsAsDataStream()	Returns the contents of the login plugin message sent by the server as an ByteArrayDataInput.
ByteArrayInputStream	contentsAsInputStream()	Returns the contents of the login plugin message sent by the server as an InputStream.
ServerConnection	getConnection()	Gets the connection from which the login plugin message was received.
byte[]	getContents()	Returns a copy of the contents contained in the login plugin message sent by the server.
ChannelIdentifier	getIdentifier()	Gets the identifier of the channel this login plugin message was sent on.
ServerLoginPluginMessageEvent.ResponseResult	getResult()	Gets the current ServerLoginPluginMessageEvent.ResponseResult associated with this plugin message event.
int	getSequenceId()	Gets the sequence ID of the plugin message sent by the server.
void	setResult(ServerLoginPluginMessageEvent.ResponseResult result)	Sets the ServerLoginPluginMessageEvent.ResponseResult for this plugin message event.
String	toString()	Returns a string representation of this ServerLoginPluginMessageEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

ServerLoginPluginMessageEvent

public ServerLoginPluginMessageEvent(ServerConnection connection,
 ChannelIdentifier identifier,
 byte[] contents,
 int sequenceId)

Constructs a new ServerLoginPluginMessageEvent.

Parameters:

connection - the connection on which the plugin message was sent

identifier - the channel identifier for the message sent

contents - the contents of the message

sequenceId - the ID of the message

Method Details

getResult

public ServerLoginPluginMessageEvent.ResponseResult getResult()

Gets the current ServerLoginPluginMessageEvent.ResponseResult associated with this plugin message event.

If the result is ServerLoginPluginMessageEvent.ResponseResult.unknown(), the proxy will indicate that it did not handle the plugin message and will return a negative response to the backend server.

Specified by:

getResult in interface ResultedEvent<ServerLoginPluginMessageEvent.ResponseResult>

Returns:

the result of this event

setResult

public void setResult(ServerLoginPluginMessageEvent.ResponseResult result)

Sets the ServerLoginPluginMessageEvent.ResponseResult for this plugin message event.

Use ServerLoginPluginMessageEvent.ResponseResult.reply(byte[]) to respond with data, or ServerLoginPluginMessageEvent.ResponseResult.unknown() to indicate that the plugin message was not handled.

Specified by:

setResult in interface ResultedEvent<ServerLoginPluginMessageEvent.ResponseResult>

Parameters:

result - the new result to apply to this event

Throws:

NullPointerException - if result is null

getConnection

public ServerConnection getConnection()

Gets the connection from which the login plugin message was received.

Returns:

the server connection

getIdentifier

public ChannelIdentifier getIdentifier()

Gets the identifier of the channel this login plugin message was sent on.

Returns:

the channel identifier

getContents

public byte[] getContents()

Returns a copy of the contents contained in the login plugin message sent by the server.

Returns:

the contents of the message

contentsAsInputStream

public ByteArrayInputStream contentsAsInputStream()

Returns the contents of the login plugin message sent by the server as an InputStream.

Returns:

the contents of the message as a stream

contentsAsDataStream

public ByteArrayDataInput contentsAsDataStream()

Returns the contents of the login plugin message sent by the server as an ByteArrayDataInput.

Returns:

the contents of the message as a DataInput

getSequenceId

public int getSequenceId()

Gets the sequence ID of the plugin message sent by the server.

Returns:

the sequence ID

toString

public String toString()

Returns a string representation of this ServerLoginPluginMessageEvent.

The output includes the connection, message channel identifier, sequence ID, base-16 encoded message content, and the current response result.

Overrides:

toString in class Object

Returns:

a human-readable string describing the event state