Package org.bukkit.event.server

Class ServerListPingEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.server.ServerEvent

org.bukkit.event.server.ServerListPingEvent

All Implemented Interfaces:

Iterable<Player>

Direct Known Subclasses:

PaperServerListPingEvent

public class ServerListPingEvent
extends ServerEvent
implements Iterable<Player>

Called when a server list ping is coming in. Displayed players can be checked and removed by iterating over this event.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServerListPingEvent(InetAddress address, String motd, int maxPlayers)	This constructor is intended for implementations that provide the iterator() method, thus provided the getNumPlayers() count.
	ServerListPingEvent(InetAddress address, String motd, int numPlayers, int maxPlayers)

Method Summary

Modifier and Type	Method	Description
InetAddress	getAddress()	Get the address the ping is coming from.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
int	getMaxPlayers()	Get the maximum number of players sent.
String	getMotd()	Get the message of the day message.
int	getNumPlayers()	Get the number of players sent.
List<String>	getSampleText()	Deprecated. Will be removed in 1.13, use PaperServerListPingEvent.getPlayerSample()
Iterator<Player>	iterator()
void	setMaxPlayers(int maxPlayers)	Set the maximum number of players sent.
void	setMotd(String motd)	Change the message of the day message.
void	setSampleText(List<String> sample)	Deprecated. Will be removed in 1.13, use PaperServerListPingEvent.getPlayerSample()
void	setServerIcon(CachedServerIcon icon)	Sets the server-icon sent to the client.

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerListPingEvent

public ServerListPingEvent(InetAddress address,
                           String motd,
                           int numPlayers,
                           int maxPlayers)

ServerListPingEvent

protected ServerListPingEvent(InetAddress address,
                              String motd,
                              int maxPlayers)

This constructor is intended for implementations that provide the iterator() method, thus provided the getNumPlayers() count.

Parameters:

address - the address of the pinger

motd - the message of the day

maxPlayers - the max number of players

Method Detail

getAddress

public InetAddress getAddress()

Get the address the ping is coming from.

Returns:

the address

getMotd

public String getMotd()

Get the message of the day message.

Returns:

the message of the day

setMotd

public void setMotd(String motd)

Change the message of the day message.

Parameters:

motd - the message of the day

getNumPlayers

public int getNumPlayers()

Get the number of players sent.

Returns:

the number of players

getMaxPlayers

public int getMaxPlayers()

Get the maximum number of players sent.

Returns:

the maximum number of players

setMaxPlayers

public void setMaxPlayers(int maxPlayers)

Set the maximum number of players sent.

Parameters:

maxPlayers - the maximum number of player

setServerIcon

public void setServerIcon(CachedServerIcon icon)
                   throws IllegalArgumentException,
                          UnsupportedOperationException

Sets the server-icon sent to the client.

Parameters:

icon - the icon to send to the client

Throws:

IllegalArgumentException - if the CachedServerIcon is not created by the caller of this event; null may be accepted for some implementations

UnsupportedOperationException - if the caller of this event does not support setting the server icon

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()

iterator

public Iterator<Player> iterator()
                          throws UnsupportedOperationException

Calling the Iterator.remove() method will force that particular player to not be displayed on the player list, decrease the size returned by getNumPlayers(), and will not be returned again by any new iterator.

Specified by:

iterator in interface Iterable<Player>

Throws:

UnsupportedOperationException - if the caller of this event does not support removing players

setSampleText

@Deprecated
public void setSampleText(List<String> sample)

Deprecated.

Will be removed in 1.13, use PaperServerListPingEvent.getPlayerSample()

Parameters:

sample - the new player list sample

getSampleText

@Deprecated
public List<String> getSampleText()

Deprecated.

Will be removed in 1.13, use PaperServerListPingEvent.getPlayerSample()

Returns:

the player list sample