org.spongepowered.api.event.server.query

Interface QueryServerEvent.Basic

All Superinterfaces:

Event, QueryServerEvent

All Known Subinterfaces:

QueryServerEvent.Full

Enclosing interface:

QueryServerEvent

public static interface QueryServerEvent.Basic
extends QueryServerEvent

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.event.server.query.QueryServerEvent

QueryServerEvent.Basic, QueryServerEvent.Full

Method Summary

Modifier and Type	Method and Description
InetSocketAddress	getAddress() Gets the address to respond with.
String	getGameType() Gets the GameType to respond with.
String	getMap() Gets the map (world) to respond with.
int	getMaxPlayerCount() Gets the max player count to respond with.
int	getMaxSize() Gets the maximum size of the data to respond with.
String	getMotd() Gets the MOTD to respond with.
int	getPlayerCount() Gets the player count to respond with.
int	getSize() Gets the current size of the data to respond with.
void	setAddress(InetSocketAddress address) Sets the address to respond with.
void	setGameType(String gameType) Sets the GameType to respond with.
void	setMap(String map) Sets the map (world) to respond with.
void	setMaxPlayerCount(int maxPlayerCount) Sets the max player count to respond with.
void	setMotd(String motd) Sets the MOTD to respond with.
void	setPlayerCount(int playerCount) Sets the player count to respond with.

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Method Detail

getMotd

String getMotd()

Gets the MOTD to respond with.

By default, this is the server's current MOTD

Returns:

The MOTD to respond with.

setMotd

void setMotd(String motd)

Sets the MOTD to respond with.

If setting the string causes the message to go over the maximum size, the message will be automatically truncated.

Parameters:

motd - The MOTD to respond with

getGameType

String getGameType()

Gets the GameType to respond with.

By default, this is SMP. If setting the string causes the message to go over the maximum size, the message will be automatically truncated.

Returns:

The GameType to respond with

setGameType

void setGameType(String gameType)

Sets the GameType to respond with.

If setting the string causes the message to go over the maximum size, the message will be automatically truncated.

Parameters:

gameType - The GameType to respond with

getMap

String getMap()

Gets the map (world) to respond with.

By default, this is the current world on the server.

Returns:

The map to respond with

setMap

void setMap(String map)

Sets the map (world) to respond with.

If setting the string causes the message to go over the maximum size, the message will be automatically truncated.

Parameters:

map - The map to respond with

getPlayerCount

int getPlayerCount()

Gets the player count to respond with.

By default, this is the number of players present on the server. If setting the string causes the message to go over the maximum size, the message will be automatically truncated.

Returns:

The player count to respond with

setPlayerCount

void setPlayerCount(int playerCount)

Sets the player count to respond with.

If setting the int causes the message to go over the maximum size, the message will be automatically truncated.

Parameters:

playerCount - The player count to respond with

getMaxPlayerCount

int getMaxPlayerCount()

Gets the max player count to respond with.

By default, this is the maximum number of players allowed on the server.

Returns:

The max player count to respond with

setMaxPlayerCount

void setMaxPlayerCount(int maxPlayerCount)

Sets the max player count to respond with.

If setting the int causes the message to go over the maximum size, the message will be automatically truncated.

Parameters:

maxPlayerCount - The max player count to respond with

getAddress

InetSocketAddress getAddress()

Gets the address to respond with.

By default, this is the address the server is listening on.

Returns:

The address to respond with

setAddress

void setAddress(InetSocketAddress address)

Sets the address to respond with.

Parameters:

address - The address to respond with

getSize

int getSize()

Gets the current size of the data to respond with.

This value is implementation-defined - it is only meaningful when compared with getMaxSize().

Returns:

The current size of the data to respond with

getMaxSize

int getMaxSize()

Gets the maximum size of the data to respond with.

If the size of the data is greater than the returned value, it will be automatically truncated. This value is implementation-defined - it is only meaningful when compared with getSize() ()}.

Returns:

The maximum size of the data to respond with