Skip to content

chore(jd): improve PlayerConnectionValidateLoginEvent #13591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Warriorrrr merged 3 commits into from
Feb 26, 2026
Merged

chore(jd): improve PlayerConnectionValidateLoginEvent #13591

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f9c740
chore(jd): mention the ability to cast the connection in PlayerConnec…
Timongcraft Feb 1, 2026
165fc8a
chore(jd): address feedback
Timongcraft Feb 4, 2026
50e9707
chore: add implNote tag
Timongcraft Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions ...i/src/main/java/io/papermc/paper/event/connection/PlayerConnectionValidateLoginEvent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package io.papermc.paper.event.connection;

import io.papermc.paper.connection.PlayerConfigurationConnection;
import io.papermc.paper.connection.PlayerConnection;
import io.papermc.paper.connection.PlayerLoginConnection;
import net.kyori.adventure.text.Component;
import org.bukkit.event.Event;
import org.bukkit.event.HandlerList;
Expand All @@ -10,8 +12,13 @@
/**
* Validates whether a player connection is able to log in.
* <p>
* Called when is attempting to log in for the first time, or is finishing up
* being configured.
* Called when a player is attempting to log in for the first time,
* or is finishing up being configured.
*
* @implNote Since 1.21.7, during these phases, the {@link #getConnection() connection}
* is either {@link PlayerLoginConnection} or {@link PlayerConfigurationConnection},
* allowing access to phase-specific API.
* <br>However, these underlying connection types are not guaranteed to be stable across versions.
*/
public class PlayerConnectionValidateLoginEvent extends Event {

Expand All @@ -29,9 +36,13 @@ public PlayerConnectionValidateLoginEvent(final PlayerConnection connection, fin

/**
* Gets the connection of the player in this event.
* Note, the type of this connection is not guaranteed to be stable across versions.
* Additionally, disconnecting the player through this connection / using any methods that may send packets
* is not supported.
* @apiNote Disconnecting the player through this connection
* or using any methods that may send packets is not supported.
*
* @implNote Since 1.21.7, this connection is either
* {@link PlayerLoginConnection} or {@link PlayerConfigurationConnection}
* depending on which phase it is fired in, allowing access to phase-specific API.
* <br>However, these underlying connection types are not guaranteed to be stable across versions.
*
* @return connection
*/
Expand Down
Loading