Cynthia Yantis / Bukkit / 0b541e604df

Commits

md_5 authored 0b541e604df 23 Dec 2023

Add PlayerLoginEvent#getRealAddress

Adapted from Spigot commit 05db99ce17aa2ad094c413254c0945e004afe326.

src/main/java/org/bukkit/event/player/PlayerLoginEvent.java

Modified

-8
+/**
-9
+ * Stores details for players attempting to log in.
-10
+ * <br>
-11
+ * Note that this event is called <i>early</i> in the player initialization
-12
+ * process. It is recommended that most options involving the Player
-13
+ * <i>entity</i> be postponed to the {@link PlayerJoinEvent} instead.
-14
+ */
-15
+public class PlayerLoginEvent extends PlayerEvent {
-16
+    private static final HandlerList handlers = new HandlerList();
-17
+    private final InetAddress address;
-+
+    private final InetAddress realAddress;
-19
+    private final String hostname;
-20
+    private Result result = Result.ALLOWED;
-21
+    private String message = "";
-22
-23
+    /**
-24
+     * This constructor defaults message to an empty string, and result to
-25
+     * ALLOWED
-26
+     *
-27
+     * @param player The {@link Player} for this event
-28
+     * @param hostname The hostname that was used to connect to the server
-29
+     * @param address The address the player used to connect, provided for
-30
+     *     timing issues
-+
+     * @param realAddress the actual, unspoofed connecting address
-32
+     */
--
+    public PlayerLoginEvent(@NotNull final Player player, @NotNull final String hostname, @NotNull final InetAddress address) {
-+
+    public PlayerLoginEvent(@NotNull final Player player, @NotNull final String hostname, @NotNull final InetAddress address, final @NotNull InetAddress realAddress) {
-34
+        super(player);
-35
+        this.hostname = hostname;
-36
+        this.address = address;
-+
+        this.realAddress = realAddress;
-+
+    }
-+
-+
+    /**
-+
+     * This constructor defaults message to an empty string, and result to
-+
+     * ALLOWED
-+
+     *
-+
+     * @param player The {@link Player} for this event
-+
+     * @param hostname The hostname that was used to connect to the server
-+
+     * @param address The address the player used to connect, provided for
-+
+     *     timing issues
-+
+     */
-+
+    public PlayerLoginEvent(@NotNull final Player player, @NotNull final String hostname, @NotNull final InetAddress address) {
-+
+        this(player, hostname, address, address);
-51
+    }
-52
-53
+    /**
-54
+     * This constructor pre-configures the event with a result and message
-55
+     *
-56
+     * @param player The {@link Player} for this event
-57
+     * @param hostname The hostname that was used to connect to the server
-58
+     * @param address The address the player used to connect, provided for
-59
+     *     timing issues
-60
+     * @param result The result status for this event
-61
+     * @param message The message to be displayed if result denies login
-+
+     * @param realAddress the actual, unspoofed connecting address
-63
+     */
--
+    public PlayerLoginEvent(@NotNull final Player player, @NotNull String hostname, @NotNull final InetAddress address, @NotNull final Result result, @NotNull final String message) {
--
+        this(player, hostname, address);
-+
+    public PlayerLoginEvent(@NotNull final Player player, @NotNull String hostname, @NotNull final InetAddress address, @NotNull final Result result, @NotNull final String message, @NotNull final InetAddress realAddress) {
-+
+        this(player, hostname, address, realAddress);
-66
+        this.result = result;
-67
+        this.message = message;
-68
+    }
-69
-70
+    /**
-71
+     * Gets the current result of the login, as an enum
-72
+     *
-73
+     * @return Current Result of the login
-74
+     */
-75
+    @NotNull
-142
+     * returning null during PlayerLoginEvent.
-143
+     *
-144
+     * @return The address for this player. For legacy compatibility, this may
-145
+     *     be null.
-146
+     */
-147
+    @NotNull
-148
+    public InetAddress getAddress() {
-149
+        return address;
-150
+    }
-151
-+
+    /**
-+
+     * Gets the connection address of this player, regardless of whether it has
-+
+     * been spoofed or not.
-+
+     *
-+
+     * @return the player's connection address
-+
+     * @see #getAddress()
-+
+     */
-+
+    @NotNull
-+
+    public InetAddress getRealAddress() {
-+
+        return realAddress;
-+
+    }
-+
-164
+    @NotNull
-165
+    @Override
-166
+    public HandlerList getHandlers() {
-167
+        return handlers;
-168
+    }
-169
-170
+    @NotNull
-171
+    public static HandlerList getHandlerList() {
-172
+        return handlers;
-173
+    }

Bukkit

Commits

Jira Issues

Add shortcut