Package com.velocitypowered.api.proxy.server

Class QueryResponse

java.lang.Object

com.velocitypowered.api.proxy.server.QueryResponse

public final class QueryResponse
extends Object

GS4 query response. This class is immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryResponse.Builder	A builder for QueryResponse objects.
static class	QueryResponse.PluginInformation	Represents a plugin in the query response.

Method Summary

Modifier and Type	Method	Description
static QueryResponse.Builder	builder()	Creates a new QueryResponse.Builder instance.
boolean	equals(Object o)
String	gameVersion()	Get game version which will be used to reply to the query.
int	hashCode()
String	hostname()	Get hostname which will be used to reply to the query.
String	mapName()	Get map name which will be used to reply to the query.
int	maxPlayers()	Get max player count which will be used to reply to the query.
int	onlinePlayers()	Get current online player count which will be used to reply to the query.
Collection<String>	players()	Get collection of players which will be used to reply to the query.
Collection<QueryResponse.PluginInformation>	plugins()	Get list of plugins which will be used to reply to the query.
String	proxyHost()	Get proxy (public facing) hostname.
int	proxyPort()	Get proxy (public facing) port.
String	proxyVersion()	Get server software (name and version) which will be used to reply to the query.
QueryResponse.Builder	toBuilder()	Creates a new QueryResponse.Builder instance from data represented by this response, so that you may create a new QueryResponse with new data.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

hostname

public String hostname()

Get hostname which will be used to reply to the query. By default it is ProxyConfig.getMotd() in plain text without colour codes.

Returns:

hostname

gameVersion

public String gameVersion()

Get game version which will be used to reply to the query. By default supported Minecraft versions range is sent.

Returns:

game version

mapName

public String mapName()

Get map name which will be used to reply to the query. By default ProxyConfig.getQueryMap() is sent.

Returns:

map name

onlinePlayers

public int onlinePlayers()

Get current online player count which will be used to reply to the query.

Returns:

online player count

maxPlayers

public int maxPlayers()

Get max player count which will be used to reply to the query.

Returns:

max player count

proxyHost

public String proxyHost()

Get proxy (public facing) hostname.

Returns:

proxy hostname

proxyPort

public int proxyPort()

Get proxy (public facing) port.

Returns:

proxy port

players

public Collection<String> players()

Get collection of players which will be used to reply to the query.

Returns:

collection of players

proxyVersion

public String proxyVersion()

Get server software (name and version) which will be used to reply to the query.

Returns:

server software

plugins

public Collection<QueryResponse.PluginInformation> plugins()

Get list of plugins which will be used to reply to the query.

Returns:

collection of plugins

toBuilder

public QueryResponse.Builder toBuilder()

Creates a new QueryResponse.Builder instance from data represented by this response, so that you may create a new QueryResponse with new data. It is guaranteed that queryResponse.toBuilder().build().equals(queryResponse): that is, if no other changes are made to the returned builder, the built instance will equal the original instance.

Returns:

QueryResponse builder

builder

public static QueryResponse.Builder builder()

Creates a new QueryResponse.Builder instance.

Returns:

QueryResponse builder

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object