summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormd_5 <git@md-5.net>2018-11-10 20:30:27 +1100
committermd_5 <git@md-5.net>2018-11-10 20:30:27 +1100
commit7b238138b08659838c87eaf0021f92fb4421427c (patch)
treec432126ee95e6647d1767d46833b46f46b70706a
parentdfbb9a1c9e32240fc52c0c10d69070ccf1551840 (diff)
downloadbukkit-7b238138b08659838c87eaf0021f92fb4421427c.tar
bukkit-7b238138b08659838c87eaf0021f92fb4421427c.tar.gz
bukkit-7b238138b08659838c87eaf0021f92fb4421427c.tar.lz
bukkit-7b238138b08659838c87eaf0021f92fb4421427c.tar.xz
bukkit-7b238138b08659838c87eaf0021f92fb4421427c.zip
SPIGOT-4478: Update PlayerLoginEvent docs
-rw-r--r--src/main/java/org/bukkit/event/player/PlayerLoginEvent.java6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java b/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java
index 8b012ea9..6368c212 100644
--- a/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java
+++ b/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java
@@ -6,7 +6,11 @@ import org.bukkit.entity.Player;
import org.bukkit.event.HandlerList;
/**
- * Stores details for players attempting to log in
+ * Stores details for players attempting to log in.
+ * <br>
+ * Note that this event is called <i>early</i> in the player initialization
+ * process. It is recommended that most options involving the Player
+ * <i>entity</i> be postponed to the {@link PlayerJoinEvent} instead.
*/
public class PlayerLoginEvent extends PlayerEvent {
private static final HandlerList handlers = new HandlerList();