From ca2227bad4db68d9c5da1a91f80d6017e55ee65c Mon Sep 17 00:00:00 2001 From: md_5 Date: Thu, 25 Sep 2014 10:23:52 +1000 Subject: [PATCH] [#1212] Clarify Javadoc of ServerConnectEvent --- .../java/net/md_5/bungee/api/event/ServerConnectEvent.java | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/api/src/main/java/net/md_5/bungee/api/event/ServerConnectEvent.java b/api/src/main/java/net/md_5/bungee/api/event/ServerConnectEvent.java index e772ea2c..17cfccd0 100644 --- a/api/src/main/java/net/md_5/bungee/api/event/ServerConnectEvent.java +++ b/api/src/main/java/net/md_5/bungee/api/event/ServerConnectEvent.java @@ -9,6 +9,12 @@ import net.md_5.bungee.api.connection.ProxiedPlayer; import net.md_5.bungee.api.plugin.Cancellable; import net.md_5.bungee.api.plugin.Event; +/** + * Called when deciding to connect to a server. At the time when this event is + * called, no connection has actually been made. Cancelling the event will + * ensure that the connection does not proceed and can be useful to prevent + * certain players from accessing certain servers. + */ @Data @ToString(callSuper = false) @EqualsAndHashCode(callSuper = false)