From 9090f37cf84301d6024a92ddcfc5bfd649811733 Mon Sep 17 00:00:00 2001 From: Xephi Date: Fri, 22 Aug 2014 07:23:33 +0200 Subject: [PATCH] Update Events Javadoc --- src/main/java/fr/xephi/authme/events/AuthMeTeleportEvent.java | 2 ++ src/main/java/fr/xephi/authme/events/LoginEvent.java | 3 +++ .../java/fr/xephi/authme/events/ProtectInventoryEvent.java | 3 +++ .../java/fr/xephi/authme/events/RegisterTeleportEvent.java | 3 +++ src/main/java/fr/xephi/authme/events/ResetInventoryEvent.java | 2 ++ .../java/fr/xephi/authme/events/RestoreInventoryEvent.java | 2 ++ src/main/java/fr/xephi/authme/events/SessionEvent.java | 2 ++ src/main/java/fr/xephi/authme/events/SpawnTeleportEvent.java | 2 ++ src/main/java/fr/xephi/authme/events/StoreInventoryEvent.java | 2 ++ 9 files changed, 21 insertions(+) diff --git a/src/main/java/fr/xephi/authme/events/AuthMeTeleportEvent.java b/src/main/java/fr/xephi/authme/events/AuthMeTeleportEvent.java index fff80d5ad..c59b52c98 100644 --- a/src/main/java/fr/xephi/authme/events/AuthMeTeleportEvent.java +++ b/src/main/java/fr/xephi/authme/events/AuthMeTeleportEvent.java @@ -4,6 +4,8 @@ import org.bukkit.Location; import org.bukkit.entity.Player; /** + * + * This event is call when AuthMe try to teleport a player * * @author Xephi59 */ diff --git a/src/main/java/fr/xephi/authme/events/LoginEvent.java b/src/main/java/fr/xephi/authme/events/LoginEvent.java index aaef2f2a3..8a265adaa 100644 --- a/src/main/java/fr/xephi/authme/events/LoginEvent.java +++ b/src/main/java/fr/xephi/authme/events/LoginEvent.java @@ -6,6 +6,9 @@ import org.bukkit.event.HandlerList; /** * +* This event is called when a player login or register through AuthMe. +* The boolean 'isLogin' will be false if, and only if, login/register failed. +* * @author Xephi59 */ public class LoginEvent extends Event { diff --git a/src/main/java/fr/xephi/authme/events/ProtectInventoryEvent.java b/src/main/java/fr/xephi/authme/events/ProtectInventoryEvent.java index 1c91931c4..8b23d5c9f 100644 --- a/src/main/java/fr/xephi/authme/events/ProtectInventoryEvent.java +++ b/src/main/java/fr/xephi/authme/events/ProtectInventoryEvent.java @@ -4,6 +4,9 @@ import org.bukkit.entity.Player; import org.bukkit.inventory.ItemStack; /** + * + * This event is call just after store inventory into cache and will + * empty the player inventory. * * @author Xephi59 */ diff --git a/src/main/java/fr/xephi/authme/events/RegisterTeleportEvent.java b/src/main/java/fr/xephi/authme/events/RegisterTeleportEvent.java index aa6ed3f9f..724b85e4d 100644 --- a/src/main/java/fr/xephi/authme/events/RegisterTeleportEvent.java +++ b/src/main/java/fr/xephi/authme/events/RegisterTeleportEvent.java @@ -4,6 +4,9 @@ import org.bukkit.Location; import org.bukkit.entity.Player; /** + * + * This event is call if, and only if, a player is teleported + * just after a register. * * @author Xephi59 */ diff --git a/src/main/java/fr/xephi/authme/events/ResetInventoryEvent.java b/src/main/java/fr/xephi/authme/events/ResetInventoryEvent.java index 3d6646645..84fbe206e 100644 --- a/src/main/java/fr/xephi/authme/events/ResetInventoryEvent.java +++ b/src/main/java/fr/xephi/authme/events/ResetInventoryEvent.java @@ -3,6 +3,8 @@ package fr.xephi.authme.events; import org.bukkit.entity.Player; /** + * + * This event is call when a creative inventory is reseted. * * @author Xephi59 */ diff --git a/src/main/java/fr/xephi/authme/events/RestoreInventoryEvent.java b/src/main/java/fr/xephi/authme/events/RestoreInventoryEvent.java index 394f92a2c..f51499a9e 100644 --- a/src/main/java/fr/xephi/authme/events/RestoreInventoryEvent.java +++ b/src/main/java/fr/xephi/authme/events/RestoreInventoryEvent.java @@ -4,6 +4,8 @@ import org.bukkit.entity.Player; import org.bukkit.inventory.ItemStack; /** + * + * This event restore the inventory from cache * * @author Xephi59 */ diff --git a/src/main/java/fr/xephi/authme/events/SessionEvent.java b/src/main/java/fr/xephi/authme/events/SessionEvent.java index f78ed378f..01f640066 100644 --- a/src/main/java/fr/xephi/authme/events/SessionEvent.java +++ b/src/main/java/fr/xephi/authme/events/SessionEvent.java @@ -3,6 +3,8 @@ package fr.xephi.authme.events; import fr.xephi.authme.cache.auth.PlayerAuth; /** + * + * This event is call when a player logging in through a timed session * * @author Xephi59 */ diff --git a/src/main/java/fr/xephi/authme/events/SpawnTeleportEvent.java b/src/main/java/fr/xephi/authme/events/SpawnTeleportEvent.java index ef85c778a..4e808dbe4 100644 --- a/src/main/java/fr/xephi/authme/events/SpawnTeleportEvent.java +++ b/src/main/java/fr/xephi/authme/events/SpawnTeleportEvent.java @@ -4,6 +4,8 @@ import org.bukkit.Location; import org.bukkit.entity.Player; /** + * + * Called if a player is teleported to a specific spawn * * @author Xephi59 */ diff --git a/src/main/java/fr/xephi/authme/events/StoreInventoryEvent.java b/src/main/java/fr/xephi/authme/events/StoreInventoryEvent.java index 95024f1b8..d61d40f31 100644 --- a/src/main/java/fr/xephi/authme/events/StoreInventoryEvent.java +++ b/src/main/java/fr/xephi/authme/events/StoreInventoryEvent.java @@ -6,6 +6,8 @@ import org.bukkit.inventory.ItemStack; import fr.xephi.authme.cache.backup.FileCache; /** + * + * This event is call just before write inventory content to cache * * @author Xephi59 */