Package org.bukkit.event.server
Class ServerListPingEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.server.ServerEvent
org.bukkit.event.server.ServerListPingEvent
- Direct Known Subclasses:
PaperServerListPingEvent
Called when a server list ping is coming in. Displayed players can be
checked and removed by
Note: The players in
iterating
over this event.
Note: The players in
iterator()
will not be shown in the
server info if Bukkit.getHideOnlinePlayers()
is true.-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Constructor Summary
ModifierConstructorDescriptionprotected
ServerListPingEvent
(@NotNull String hostname, @NotNull InetAddress address, @NotNull String motd, int maxPlayers) Deprecated.ServerListPingEvent
(@NotNull String hostname, @NotNull InetAddress address, @NotNull String motd, int numPlayers, int maxPlayers) protected
ServerListPingEvent
(@NotNull String hostname, @NotNull InetAddress address, @NotNull Component motd, int maxPlayers) This constructor is intended for implementations that provide theiterator()
method, thus provided thegetNumPlayers()
count.ServerListPingEvent
(@NotNull String hostname, @NotNull InetAddress address, Component motd, int numPlayers, int maxPlayers) protected
ServerListPingEvent
(@NotNull InetAddress address, Component motd, int maxPlayers) Deprecated.ServerListPingEvent
(@NotNull InetAddress address, Component motd, int numPlayers, int maxPlayers) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionGet the address the ping is coming from.static @NotNull HandlerList
Gets the hostname that the player used to connect to the server, or blank if unknownint
Get the maximum number of players sent.getMotd()
Deprecated.in favour ofmotd()
int
Get the number of players sent.iterator()
Deprecated, for removal: This API element is subject to removal in a future version.the Iterable interface will be removed at some pointmotd()
Get the message of the day message.void
Change the message of the day message.void
setMaxPlayers
(int maxPlayers) Set the maximum number of players sent.void
Deprecated.in favour ofmotd(net.kyori.adventure.text.Component)
void
Sets the server-icon sent to the client.boolean
Deprecated.chat previews have been removedMethods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
ServerListPingEvent
-
ServerListPingEvent
@Deprecated protected ServerListPingEvent(@NotNull @NotNull String hostname, @NotNull @NotNull InetAddress address, @NotNull @NotNull String motd, int maxPlayers) Deprecated.This constructor is intended for implementations that provide theiterator()
method, thus provided thegetNumPlayers()
count.- Parameters:
hostname
- The hostname that was used to connect to the serveraddress
- the address of the pingermotd
- the message of the daymaxPlayers
- the max number of players
-
ServerListPingEvent
@Deprecated public ServerListPingEvent(@NotNull @NotNull InetAddress address, @NotNull Component motd, int numPlayers, int maxPlayers) Deprecated. -
ServerListPingEvent
-
ServerListPingEvent
@Deprecated protected ServerListPingEvent(@NotNull @NotNull InetAddress address, @NotNull Component motd, int maxPlayers) Deprecated.This constructor is intended for implementations that provide theiterator()
method, thus provided thegetNumPlayers()
count.- Parameters:
address
- the address of the pingermotd
- the message of the daymaxPlayers
- the max number of players
-
ServerListPingEvent
protected ServerListPingEvent(@NotNull @NotNull String hostname, @NotNull @NotNull InetAddress address, @NotNull Component motd, int maxPlayers) This constructor is intended for implementations that provide theiterator()
method, thus provided thegetNumPlayers()
count.- Parameters:
hostname
- The hostname that was used to connect to the serveraddress
- the address of the pingermotd
- the message of the daymaxPlayers
- the max number of players
-
-
Method Details
-
motd
Get the message of the day message.- Returns:
- the message of the day
-
motd
Change the message of the day message.- Parameters:
motd
- the message of the day
-
getHostname
Gets the hostname that the player used to connect to the server, or blank if unknown- Returns:
- The hostname
-
getAddress
Get the address the ping is coming from.- Returns:
- the address
-
getMotd
Deprecated.in favour ofmotd()
Get the message of the day message.- Returns:
- the message of the day
-
setMotd
Deprecated.in favour ofmotd(net.kyori.adventure.text.Component)
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
-
shouldSendChatPreviews
Deprecated.chat previews have been removedGets whether the server needs to send a preview of the chat to the client.- Returns:
- true if chat preview is enabled, false otherwise
-
setMaxPlayers
public void setMaxPlayers(int maxPlayers) Set the maximum number of players sent.- Parameters:
maxPlayers
- the maximum number of player
-
setServerIcon
public void setServerIcon(@UndefinedNullability("implementation dependent") 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 theCachedServerIcon
is not created by the caller of this event; null may be accepted for some implementationsUnsupportedOperationException
- if the caller of this event does not support setting the server icon
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-
iterator
@NotNull @Deprecated(forRemoval=true, since="1.20.6") public @NotNull Iterator<Player> iterator() throws UnsupportedOperationExceptionDeprecated, for removal: This API element is subject to removal in a future version.the Iterable interface will be removed at some pointCalling the
Iterator.remove()
method will force that particular player to not be displayed on the player list, decrease the size returned bygetNumPlayers()
, and will not be returned again by any new iterator.
Note: The players here will not be shown in the server info ifBukkit.getHideOnlinePlayers()
is true.- Specified by:
iterator
in interfaceIterable<Player>
- Throws:
UnsupportedOperationException
- if the caller of this event does not support removing players
-
ServerListPingEvent(String, java.net.InetAddress, net.kyori.adventure.text.Component, int)