From 6b88b639413a86d24e738b9d03a04d712a4e3c2a Mon Sep 17 00:00:00 2001 From: md_5 Date: Sun, 28 Jan 2018 10:20:03 +1100 Subject: [PATCH] #2335: Clarify JavaDoc for methods in PendingConnection --- .../md_5/bungee/api/connection/PendingConnection.java | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/api/src/main/java/net/md_5/bungee/api/connection/PendingConnection.java b/api/src/main/java/net/md_5/bungee/api/connection/PendingConnection.java index cc511ef14..f497395eb 100644 --- a/api/src/main/java/net/md_5/bungee/api/connection/PendingConnection.java +++ b/api/src/main/java/net/md_5/bungee/api/connection/PendingConnection.java @@ -56,11 +56,16 @@ public interface PendingConnection extends Connection /** * Set the connection's uuid + * + * @param uuid connection UUID */ void setUniqueId(UUID uuid); /** * Get this connection's online mode. + *
+ * See {@link #setOnlineMode(boolean)} for a description of how this option + * works. * * @return the online mode */ @@ -68,6 +73,12 @@ public interface PendingConnection extends Connection /** * Set this connection's online mode. + *
+ * May be called only during the PlayerHandshakeEvent to set the online mode + * configuration setting for this connection only (i.e. whether or not the + * client will be treated as if it is connecting to an online mode server). + * + * @param onlineMode status */ void setOnlineMode(boolean onlineMode);