org.spongepowered.api.network.status

Interface StatusResponse

All Known Subinterfaces:

ClientPingServerEvent.Response

public interface StatusResponse

Represents the response to a status request. Unlike ClientPingServerEvent this is immutable.

This interface exists mostly for convenience and can be implemented in a library pinging other servers for example.

See Also:

ClientPingServerEvent

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StatusResponse.Players Represents the player count, slots and a list of players current playing on a server.

Method Summary

Modifier and Type	Method and Description
Text	getDescription() Gets the description (MOTD) of the status response.
Optional<Favicon>	getFavicon() Gets the Favicon of the server.
Optional<? extends StatusResponse.Players>	getPlayers() Gets player count and the list of players currently playing on the server.
MinecraftVersion	getVersion() Gets the version of the server displayed when the client or the server are outdated.

Method Detail

getDescription

Text getDescription()

Gets the description (MOTD) of the status response.

Returns:

The description to display

getPlayers

Optional<? extends StatusResponse.Players> getPlayers()

Gets player count and the list of players currently playing on the server.

Returns:

The player information, or Optional.empty() if not available

getVersion

MinecraftVersion getVersion()

Gets the version of the server displayed when the client or the server are outdated.

Returns:

The server version

getFavicon

Optional<Favicon> getFavicon()

Gets the Favicon of the server.

Returns:

The favicon, or Optional.empty() if not available