org.spongepowered.api.event.server

Interface ClientPingServerEvent.Response

All Superinterfaces:

StatusResponse

Enclosing interface:

ClientPingServerEvent

public static interface ClientPingServerEvent.Response
extends StatusResponse

Represents a mutable response to a status request.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ClientPingServerEvent.Response.Players Represents the information about the players on the server, sent after the ClientPingServerEvent.

Method Summary

Modifier and Type	Method and Description
Optional<ClientPingServerEvent.Response.Players>	getPlayers() Gets player count and the list of players currently playing on the server.
void	setDescription(Text description) Sets the description (MOTD) of the status response.
void	setFavicon(Favicon favicon) Sets the Favicon to display on the client.
void	setHidePlayers(boolean hide) Sets whether the player count and the list of players on this server is hidden and doesn't get sent to the client.

Methods inherited from interface org.spongepowered.api.network.status.StatusResponse

getDescription, getFavicon, getVersion

Method Detail

setDescription

void setDescription(Text description)

Sets the description (MOTD) of the status response.

Parameters:

description - The description to display

getPlayers

Optional<ClientPingServerEvent.Response.Players> getPlayers()

Description copied from interface: StatusResponse

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

Specified by:

getPlayers in interface StatusResponse

Returns:

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

setHidePlayers

void setHidePlayers(boolean hide)

Sets whether the player count and the list of players on this server is hidden and doesn't get sent to the client. This will restore getPlayers() if the players were previously hidden.

Use getPlayers().isPresent() to check if the players are already hidden.

In Vanilla, this will display ??? instead of the player count in the server list.

Parameters:

hide - True if the players should be hidden

setFavicon

void setFavicon(@Nullable
                Favicon favicon)

Sets the Favicon to display on the client.

Parameters:

favicon - The favicon, or null for none