com.comphenix.protocol.wrappers

Class WrappedServerPing

java.lang.Object

com.comphenix.protocol.wrappers.AbstractWrapper

com.comphenix.protocol.wrappers.WrappedServerPing

public class WrappedServerPing
extends AbstractWrapper

Represents a server ping packet data.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WrappedServerPing.CompressedImage Represents a compressed favicon.

Field Summary

Fields inherited from class com.comphenix.protocol.wrappers.AbstractWrapper

handle, handleType

Constructor Summary

Constructors

Constructor and Description
WrappedServerPing() Construct a new server ping initialized with a zero player count, and zero maximum.

Method Summary

Methods

Modifier and Type	Method and Description
WrappedServerPing	deepClone() Retrieve a deep copy of the current wrapper object.
static WrappedServerPing	fromHandle(java.lang.Object handle) Construct a wrapped server ping from a native NMS object.
static WrappedServerPing	fromJson(java.lang.String json) Construct a wrapper server ping from an encoded JSON string.
WrappedServerPing.CompressedImage	getFavicon() Retrieve the compressed PNG file that is being displayed as a favicon.
WrappedChatComponent	getMotD() Retrieve the message of the day.
com.google.common.collect.ImmutableList<WrappedGameProfile>	getPlayers() Retrieve a copy of all the logged in players.
int	getPlayersMaximum() Retrieve the displayed maximum number of players.
int	getPlayersOnline() Retrieve the displayed number of online players.
java.lang.String	getVersionName() Retrieve the version name of the current server.
int	getVersionProtocol() Retrieve the protocol number.
boolean	isPlayersVisible() Determine if the player count and maximum is visible.
protected void	resetPlayers() Set the player count and player maximum to the default values.
protected void	resetVersion() Reset the version string to the default state.
void	setBukkitPlayers(java.lang.Iterable<? extends org.bukkit.entity.Player> players) Set the displayed lst of logged in players.
void	setFavicon(WrappedServerPing.CompressedImage image) Set the compressed PNG file that is being displayed.
void	setMotD(java.lang.String message) Set the message of the day.
void	setMotD(WrappedChatComponent description) Set the message of the day.
void	setPlayers(java.lang.Iterable<? extends WrappedGameProfile> profile) Set the displayed list of logged in players.
void	setPlayersMaximum(int maximum) Set the displayed maximum number of players.
void	setPlayersOnline(int online) Set the displayed number of online players.
void	setPlayersVisible(boolean visible) Set whether or not the player count and player maximum is visible.
void	setVersionName(java.lang.String name) Set the version name of the current server.
void	setVersionProtocol(int protocol) Set the version protocol
java.lang.String	toJson() Retrieve the underlying JSON representation of this server ping.
java.lang.String	toString()

Methods inherited from class com.comphenix.protocol.wrappers.AbstractWrapper

getHandle, getHandleType, setHandle

Methods inherited from class java.lang.Object

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

Constructor Detail

WrappedServerPing

public WrappedServerPing()

Construct a new server ping initialized with a zero player count, and zero maximum.

Note that the version string is set to 1.7.2.

Method Detail

resetPlayers

protected void resetPlayers()

Set the player count and player maximum to the default values.

resetVersion

protected void resetVersion()

Reset the version string to the default state.

fromHandle

public static WrappedServerPing fromHandle(java.lang.Object handle)

Construct a wrapped server ping from a native NMS object.

Parameters:

handle - - the native object.

Returns:

The wrapped server ping object.

fromJson

public static WrappedServerPing fromJson(java.lang.String json)

Construct a wrapper server ping from an encoded JSON string.

Parameters:

json - - the JSON string.

Returns:

The wrapped server ping.

getMotD

public WrappedChatComponent getMotD()

Retrieve the message of the day.

Returns:

The messge of the day.

setMotD

public void setMotD(WrappedChatComponent description)

Set the message of the day.

Parameters:

description - - message of the day.

setMotD

public void setMotD(java.lang.String message)

Set the message of the day.

Parameters:

description - - the message.

getFavicon

public WrappedServerPing.CompressedImage getFavicon()

Retrieve the compressed PNG file that is being displayed as a favicon.

Returns:

The favicon, or NULL if no favicon will be displayed.

setFavicon

public void setFavicon(WrappedServerPing.CompressedImage image)

Set the compressed PNG file that is being displayed.

Parameters:

image - - the new compressed image or NULL if no favicon should be displayed.

getPlayersOnline

public int getPlayersOnline()

Retrieve the displayed number of online players.

Returns:

The displayed number.

Throws:

java.lang.IllegalStateException - If the player count has been hidden via setPlayersVisible(boolean).

See Also:

#setPlayersOnline(int)} for more information.

setPlayersOnline

public void setPlayersOnline(int online)

Set the displayed number of online players.

As of 1.7.2, this is completely unrestricted, and can be both positive and negative, as well as higher than the player maximum.

Parameters:

online - - online players.

getPlayersMaximum

public int getPlayersMaximum()

Retrieve the displayed maximum number of players.

Returns:

The maximum number.

Throws:

java.lang.IllegalStateException - If the player maximum has been hidden via setPlayersVisible(boolean).

See Also:

#setPlayersMaximum(int)} for more information.

setPlayersMaximum

public void setPlayersMaximum(int maximum)

Set the displayed maximum number of players.

The 1.7.2 accepts any value as a player maximum, positive or negative. It even permits a player maximum that is less than the player count.

Parameters:

maximum - - maximum player count.

setPlayersVisible

public void setPlayersVisible(boolean visible)

Set whether or not the player count and player maximum is visible.

Note that this may set the current player count and maximum to their respective real values.

Parameters:

visible - - TRUE if it should be visible, FALSE otherwise.

isPlayersVisible

public boolean isPlayersVisible()

Determine if the player count and maximum is visible.

If not, the client will display ??? in the same location.

Returns:

TRUE if the player statistics is visible, FALSE otherwise.

getPlayers

public com.google.common.collect.ImmutableList<WrappedGameProfile> getPlayers()

Retrieve a copy of all the logged in players.

Returns:

Logged in players or an empty list if no player names will be displayed.

setPlayers

public void setPlayers(java.lang.Iterable<? extends WrappedGameProfile> profile)

Set the displayed list of logged in players.

Parameters:

profile - - every logged in player.

setBukkitPlayers

public void setBukkitPlayers(java.lang.Iterable<? extends org.bukkit.entity.Player> players)

Set the displayed lst of logged in players.

Parameters:

players - - the players to display.

getVersionName

public java.lang.String getVersionName()

Retrieve the version name of the current server.

Returns:

The version name.

setVersionName

public void setVersionName(java.lang.String name)

Set the version name of the current server.

Parameters:

name - - the new version name.

getVersionProtocol

public int getVersionProtocol()

Retrieve the protocol number.

Returns:

The protocol.

setVersionProtocol

public void setVersionProtocol(int protocol)

Set the version protocol

Parameters:

protocol - - the protocol number.

deepClone

public WrappedServerPing deepClone()

Retrieve a deep copy of the current wrapper object.

Returns:

The current object.

toJson

public java.lang.String toJson()

Retrieve the underlying JSON representation of this server ping.

Returns:

The JSON representation.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object