Spigot / Bukkit / 9a4de097690

Commits

md_5 authored 9a4de097690 28 Oct 2022

SPIGOT-7171: Ability to get the IP/hostname players are requesting status of

src/main/java/org/bukkit/event/server/ServerListPingEvent.java

Modified

-13
+/**
-14
+ * Called when a server list ping is coming in. Displayed players can be
-15
+ * checked and removed by {@link #iterator() iterating} over this event.
-16
+ * <br>
-17
+ * <b>Note:</b> The players in {@link #iterator()} will not be shown in the
-18
+ * server info if {@link Bukkit#getHideOnlinePlayers()} is true.
-19
+ */
-20
+public class ServerListPingEvent extends ServerEvent implements Iterable<Player> {
-21
+    private static final int MAGIC_PLAYER_COUNT = Integer.MIN_VALUE;
-22
+    private static final HandlerList handlers = new HandlerList();
-+
+    private final String hostname;
-24
+    private final InetAddress address;
-25
+    private final boolean shouldSendChatPreviews;
-26
+    private String motd;
-27
+    private final int numPlayers;
-28
+    private int maxPlayers;
-29
-+
+    @Deprecated
-31
+    public ServerListPingEvent(@NotNull final InetAddress address, @NotNull final String motd, final boolean shouldSendChatPreviews, final int numPlayers, final int maxPlayers) {
-+
+        this("", address, motd, shouldSendChatPreviews, numPlayers, maxPlayers);
-+
+    }
-+
-+
+    public ServerListPingEvent(@NotNull final String hostname, @NotNull final InetAddress address, @NotNull final String motd, final boolean shouldSendChatPreviews, final int numPlayers, final int maxPlayers) {
-36
+        super(true);
-37
+        Preconditions.checkArgument(numPlayers >= 0, "Cannot have negative number of players online", numPlayers);
-+
+        this.hostname = hostname;
-39
+        this.address = address;
-40
+        this.motd = motd;
-41
+        this.shouldSendChatPreviews = shouldSendChatPreviews;
-42
+        this.numPlayers = numPlayers;
-43
+        this.maxPlayers = maxPlayers;
-44
+    }
-45
-+
+    @Deprecated
-+
+    protected ServerListPingEvent(@NotNull final InetAddress address, @NotNull final String motd, boolean shouldSendChatPreviews, final int maxPlayers) {
-+
+        this("", address, motd, shouldSendChatPreviews, maxPlayers);
-+
+    }
-+
-51
+    /**
-52
+     * This constructor is intended for implementations that provide the
-53
+     * {@link #iterator()} method, thus provided the {@link #getNumPlayers()}
-54
+     * count.
-55
+     *
-+
+     * @param hostname The hostname that was used to connect to the server
-57
+     * @param address the address of the pinger
-58
+     * @param motd the message of the day
-59
+     * @param shouldSendChatPreviews if the server should send chat previews
-60
+     * @param maxPlayers the max number of players
-61
+     */
--
+    protected ServerListPingEvent(@NotNull final InetAddress address, @NotNull final String motd, boolean shouldSendChatPreviews, final int maxPlayers) {
-+
+    protected ServerListPingEvent(@NotNull final String hostname, @NotNull final InetAddress address, @NotNull final String motd, boolean shouldSendChatPreviews, final int maxPlayers) {
-63
+        super(true);
-64
+        this.numPlayers = MAGIC_PLAYER_COUNT;
-+
+        this.hostname = hostname;
-66
+        this.address = address;
-67
+        this.motd = motd;
-68
+        this.shouldSendChatPreviews = shouldSendChatPreviews;
-69
+        this.maxPlayers = maxPlayers;
-70
+    }
-71
-+
+    /**
-+
+     * Gets the hostname that the player used to connect to the server, or
-+
+     * blank if unknown
-+
+     *
-+
+     * @return The hostname
-+
+     */
-+
+    @NotNull
-+
+    public String getHostname() {
-+
+        return hostname;
-+
+    }
-+
-83
+    /**
-84
+     * Get the address the ping is coming from.
-85
+     *
-86
+     * @return the address
-87
+     */
-88
+    @NotNull
-89
+    public InetAddress getAddress() {
-90
+        return address;
-91
+    }
-92

Bukkit

Commits

Jira Issues

Add shortcut