MiniDay/Velocity
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

Document ServerPreConnectEvent more carefully.

Browse Source
This commit is contained in:
Andrew Steinborn
2018-11-25 14:54:03 -05:00
parent 8f859b980c
commit edfdcf3d53
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
api/src/main/java/com/velocitypowered/api/event/player/ServerPreConnectEvent.java
View File

@@ -30,6 +30,10 @@ public final class ServerPreConnectEvent implements
this.result = ServerResult.allowed(originalServer); this.result = ServerResult.allowed(originalServer);
} }
/**
* Returns the player connecting to the server.
* @return the player connecting to the server
*/
public Player getPlayer() { public Player getPlayer() {
return player; return player;
} }
@@ -44,6 +48,12 @@ public final class ServerPreConnectEvent implements
this.result = Preconditions.checkNotNull(result, "result"); this.result = Preconditions.checkNotNull(result, "result");
} }
/**
* Returns the server that the player originally tried to connect to. To get the server the
* player will connect to, see the {@link ServerResult} of this event. To get the server the
* player is currently on when this event is fired, use {@link Player#getCurrentServer()}.
* @return the server that the player originally tried to connect to
*/
public RegisteredServer getOriginalServer() { public RegisteredServer getOriginalServer() {
return originalServer; return originalServer;
} }