org.henrya.pingapi.api

Class PingReply

java.lang.Object

org.henrya.pingapi.api.PingReply

public class PingReply
extends java.lang.Object

A class that defines the data that will be sent to the client in a PacketStatusOutServerInfo packet

Author:

Henry Anderson

Constructor Summary

Constructors

Constructor and Description
PingReply(java.lang.Object ctx, java.lang.String motd, int onlinePlayers, int maxPlayers, int protocolVersion, java.lang.String protocolName, java.util.List<java.lang.String> playerSample) Creates a class to store data that will be sent to the client in a PacketStatusOutServerInfo packet

Method Summary

Modifier and Type	Method and Description
org.bukkit.util.CachedServerIcon	getIcon() Returns the server's icon that is to be sent to the client
int	getMaxPlayers() Returns the maximum amount of players to be sent to the client
java.lang.String	getMOTD() Returns the MOTD to be sent to the client
int	getOnlinePlayers() Returns the amount of online players to be sent to the client
java.util.List<java.lang.String>	getPlayerSample() Returns a list of player names to be sent to the client
java.lang.String	getProtocolName() Returns the protocol name to be sent to the client
int	getProtocolVersion() Returns the protocol version to be sent to the client
void	hidePlayerSample(boolean hidePlayerSample) Sets whether the player sample should be hidden
boolean	isPlayerSampleHidden() Returns whether the player sample is to be hidden
void	setIcon(org.bukkit.util.CachedServerIcon icon) Sets the icon to be sent to the client
void	setMaxPlayers(int maxPlayers) Sets the maximum amount of players to be sent to the client
void	setMOTD(java.lang.String motd) Sets the MOTD to be sent to the client
void	setOnlinePlayers(int onlinePlayers) Sets the amount of online players to be sent to the client
void	setPlayerSample(java.util.List<java.lang.String> playerSample) Sets the list of player names that will be sent to the client Note that if the player sample is hidden this list will not be sent
void	setProtocolName(java.lang.String protocolName) Sets the protocol name to be sent to the client
void	setProtocolVersion(int protocolVersion) Sets the protocol version to be sent to the client

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PingReply

public PingReply(java.lang.Object ctx,
                 java.lang.String motd,
                 int onlinePlayers,
                 int maxPlayers,
                 int protocolVersion,
                 java.lang.String protocolName,
                 java.util.List<java.lang.String> playerSample)

Creates a class to store data that will be sent to the client in a PacketStatusOutServerInfo packet

Parameters:

ctx - The ChannelHandlerContext instance

motd - The MOTD

onlinePlayers - The amount of online players

maxPlayers - The maximum amount of players

protocolVersion - The protocol version

protocolName - The name of the protocol

playerSample - A list of player names

Method Detail

getOnlinePlayers

public int getOnlinePlayers()

Returns the amount of online players to be sent to the client

Returns:

An integer representing the online players

getMaxPlayers

public int getMaxPlayers()

Returns the maximum amount of players to be sent to the client

Returns:

An integer representing the max players

getMOTD

public java.lang.String getMOTD()

Returns the MOTD to be sent to the client

Returns:

A String representing the MOTD

getProtocolVersion

public int getProtocolVersion()

Returns the protocol version to be sent to the client

Returns:

An integer representing the protocol version

getProtocolName

public java.lang.String getProtocolName()

Returns the protocol name to be sent to the client

Returns:

A String representing the protocol's name

getPlayerSample

public java.util.List<java.lang.String> getPlayerSample()

Returns a list of player names to be sent to the client

Returns:

A list of player names

isPlayerSampleHidden

public boolean isPlayerSampleHidden()

Returns whether the player sample is to be hidden

Returns:

A boolean

getIcon

public org.bukkit.util.CachedServerIcon getIcon()

Returns the server's icon that is to be sent to the client

Returns:

The server icon

setOnlinePlayers

public void setOnlinePlayers(int onlinePlayers)

Sets the amount of online players to be sent to the client

Parameters:

onlinePlayers - Amount of online players

setMaxPlayers

public void setMaxPlayers(int maxPlayers)

Sets the maximum amount of players to be sent to the client

Parameters:

maxPlayers - Amount of maximum players

setMOTD

public void setMOTD(java.lang.String motd)

Sets the MOTD to be sent to the client

Parameters:

motd - The MOTD

setProtocolVersion

public void setProtocolVersion(int protocolVersion)

Sets the protocol version to be sent to the client

Parameters:

protocolVersion - The protocol version

setProtocolName

public void setProtocolName(java.lang.String protocolName)

Sets the protocol name to be sent to the client

Parameters:

protocolName - The protocol's name

setPlayerSample

public void setPlayerSample(java.util.List<java.lang.String> playerSample)

Sets the list of player names that will be sent to the client Note that if the player sample is hidden this list will not be sent

Parameters:

playerSample - New list of player names

hidePlayerSample

public void hidePlayerSample(boolean hidePlayerSample)

Sets whether the player sample should be hidden

Parameters:

hidePlayerSample - A boolean

setIcon

public void setIcon(org.bukkit.util.CachedServerIcon icon)

Sets the icon to be sent to the client

Parameters:

icon - The icon