Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-31 21:37:39 +01:00
Code Issues Projects Releases Wiki Activity

Add docs in ServerListPingEvent based on changes from 1.18

Browse Source 
By: Doc <nachito94@msn.com>
This commit is contained in:
Bukkit/Spigot 2021-11-24 07:30:57 +11:00
parent d0acafa8d8
commit b06bd45d47
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
paper-api/src/main/java/org/bukkit/event/server/ServerListPingEvent.java
View File

@ -3,6 +3,7 @@ package org.bukkit.event.server;
import java.net.InetAddress;
import java.util.Iterator;
import org.apache.commons.lang.Validate;
import org.bukkit.Bukkit;
import org.bukkit.UndefinedNullability;
import org.bukkit.entity.Player;
import org.bukkit.event.HandlerList;
@ -12,6 +13,9 @@ import org.jetbrains.annotations.NotNull;
/**
* Called when a server list ping is coming in. Displayed players can be
* checked and removed by {@link #iterator() iterating} over this event.
* <br>
* <b>Note:</b> The players in {@link #iterator()} will not be shown in the
* server info if {@link Bukkit#getHideOnlinePlayers()} is true.
*/
public class ServerListPingEvent extends ServerEvent implements Iterable<Player> {
private static final int MAGIC_PLAYER_COUNT = Integer.MIN_VALUE;
@ -142,6 +146,9 @@ public class ServerListPingEvent extends ServerEvent implements Iterable<Player>
* player to not be displayed on the player list, decrease the size
* returned by {@link #getNumPlayers()}, and will not be returned again by
* any new iterator.
* <br>
* <b>Note:</b> The players here will not be shown in the server info if
* {@link Bukkit#getHideOnlinePlayers()} is true.
*
* @throws UnsupportedOperationException if the caller of this event does
* not support removing players