Skip to content

Add custom disconnect reason to PlayerChooseInitialServerEvent #1583

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

Open
wants to merge 2 commits into
base: dev/3.0.0
Choose a base branch
from
+24 −3
Open

Add custom disconnect reason to PlayerChooseInitialServerEvent #1583

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb61e66
Add custom disconnect reason to PlayerChooseInitialServerEvent
radek203 May 30, 2025
0bc87b3
Merge branch 'PaperMC:dev/3.0.0' into dev/3.0.0
radek203 Sep 27, 2025
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
17 changes: 17 additions & 0 deletions api/src/main/java/com/velocitypowered/api/event/player/PlayerChooseInitialServerEvent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import com.velocitypowered.api.proxy.Player;
import com.velocitypowered.api.proxy.server.RegisteredServer;
import java.util.Optional;
import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
Expand All @@ -25,6 +26,7 @@ public class PlayerChooseInitialServerEvent {

private final Player player;
private @Nullable RegisteredServer initialServer;
private @Nullable Component reason;

/**
* Constructs a PlayerChooseInitialServerEvent.
Expand All @@ -35,6 +37,7 @@ public class PlayerChooseInitialServerEvent {
public PlayerChooseInitialServerEvent(Player player, @Nullable RegisteredServer initialServer) {
this.player = Preconditions.checkNotNull(player, "player");
this.initialServer = initialServer;
this.reason = null;
}

public Player getPlayer() {
Expand All @@ -54,6 +57,20 @@ public void setInitialServer(@Nullable RegisteredServer server) {
this.initialServer = server;
}

public Optional<Component> getReason() {
return Optional.ofNullable(reason);
}

/**
* Sets a custom disconnect reason for the player.
* Passing {@code null} will show the default reason.
*
* @param reason the disconnect reason to show to the player
*/
Comment on lines +65 to +69
Copy link
Contributor

@4drian3d 4drian3d Sep 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good to detail the functionality of the method, something like: “if a valid server is not provided as the initial server, this message will be used to disconnect the player; if it is not present or null is used, the default message will be used”

Copy link
Contributor

@Emilxyz Emilxyz Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of allowing null here, maybe we just fire the event with the default message as initial reason?

public void setReason(@Nullable Component reason) {
this.reason = reason;
}

@Override
public String toString() {
return "PlayerChooseInitialServerEvent{"
Expand Down
10 changes: 7 additions & 3 deletions proxy/src/main/java/com/velocitypowered/proxy/connection/client/AuthSessionHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,9 +262,13 @@ private CompletableFuture<Void> connectToInitialServer(ConnectedPlayer player) {
return server.getEventManager().fire(event).thenRunAsync(() -> {
Optional<RegisteredServer> toTry = event.getInitialServer();
if (toTry.isEmpty()) {
player.disconnect0(
Component.translatable("velocity.error.no-available-servers", NamedTextColor.RED),
true);
if (event.getReason().isPresent()) {
player.disconnect0(event.getReason().get(), true);
} else {
player.disconnect0(
Component.translatable("velocity.error.no-available-servers", NamedTextColor.RED),
true);
}
return;
}
player.createConnectionRequest(toTry.get()).fireAndForget();
Expand Down