From f82a3481ac757fcf9c89f13309c952a4b1347ec0 Mon Sep 17 00:00:00 2001
From: unurled <lch0ssah.dev@gmail.com>
Date: Thu, 28 Apr 2022 15:07:15 +0200
Subject: [PATCH] 0.5.1 add javadocs same as previous commit

---
 .../java/gq/unurled/raxen/config/Config.java  |  3 ++
 .../gq/unurled/raxen/config/PlayerConfig.java | 34 +++++++++++++++++++
 .../raxen/listener/entity/DamageEntity.java   |  9 +++++
 .../raxen/listener/entity/SpawnEvent.java     |  7 +++-
 .../raxen/listener/player/ArmorEvent.java     |  4 +++
 .../listener/player/ClickBlockEvent.java      |  4 +++
 .../listener/player/CloseInventoryEvent.java  |  4 +++
 .../raxen/listener/player/ItemHandEvent.java  |  4 +++
 .../raxen/listener/player/JoinEvent.java      |  4 +++
 .../raxen/listener/player/LeaveEvent.java     |  5 +++
 .../listener/player/ServerPingEvent.java      |  4 +++
 .../listener/player/TransactionEvent.java     |  4 +++
 .../raxen/manager/entity/EntityManager.java   |  5 +++
 .../raxen/manager/entity/ItemManager.java     |  9 +++++
 .../raxen/manager/entity/PlayerManager.java   |  8 +++++
 .../raxen/manager/entity/StorageManager.java  | 21 ++++++++++++
 .../raxen/manager/server/CommandManager.java  |  3 ++
 .../raxen/manager/server/DungeonsManager.java |  3 ++
 .../server}/EnchantmentManager.java           |  3 +-
 .../raxen/manager/server/ListenerManager.java |  3 ++
 .../manager/server/ResourcePackManager.java   |  3 ++
 .../raxen/manager/server/WorldManager.java    |  7 ++++
 22 files changed, 149 insertions(+), 2 deletions(-)
 rename src/main/java/gq/unurled/raxen/{listener/player => manager/server}/EnchantmentManager.java (92%)

diff --git a/src/main/java/gq/unurled/raxen/config/Config.java b/src/main/java/gq/unurled/raxen/config/Config.java
index 6037dec..5eb0ce6 100644
--- a/src/main/java/gq/unurled/raxen/config/Config.java
+++ b/src/main/java/gq/unurled/raxen/config/Config.java
@@ -26,6 +26,9 @@ public class Config {
         this.init();
     }
 
+    /**
+     * init method, saves config and everything
+     */
     public void init() {
         FileConfiguration config = main.getConfig();
         File configFile = new File(main.getDataFolder() + "/config.yml");
diff --git a/src/main/java/gq/unurled/raxen/config/PlayerConfig.java b/src/main/java/gq/unurled/raxen/config/PlayerConfig.java
index 5bf71cf..8360a73 100644
--- a/src/main/java/gq/unurled/raxen/config/PlayerConfig.java
+++ b/src/main/java/gq/unurled/raxen/config/PlayerConfig.java
@@ -53,10 +53,20 @@ public class PlayerConfig {
         this.attributes = new Attributes(main);
     }
 
+    /**
+     * closes mongo connection
+     */
     public void close()  {
         mongoDB.close();
     }
 
+    /**
+     * save players stuff to mongo db
+     * @param player
+     * @param attributes
+     * @param invstr
+     * @param reverse
+     */
     public void saveUsingMongoDB(@NotNull Player player, Attributes attributes, String invstr, Integer reverse) {
         debug(main, "Saving " + player.getName() + "'s data!");
         Document doc = new Document("uuid", player.getUniqueId().toString())
@@ -95,6 +105,13 @@ public class PlayerConfig {
         }
     }
 
+    /**
+     * save players stuff to yml
+     * @param player
+     * @param attributes
+     * @param invstr
+     * @param reverse
+     */
     public void saveUsingYml(Player player, Attributes attributes, String invstr, Integer reverse) {
         FileConfiguration config = sto.createYml(player);
         config.set("name", player.getName());
@@ -126,6 +143,10 @@ public class PlayerConfig {
         }
     }
 
+    /**
+     * load player stuff from mongo db
+     * @param player
+     */
     public void loadUsingMongoDB(@NotNull Player player) {
         Document playerDoc = mongoCollection.find(Filters.eq("uuid", player.getUniqueId().toString())).first();
         if(playerDoc == null) {
@@ -159,6 +180,11 @@ public class PlayerConfig {
         PlayerUtils.updateSkills(main, player);
     }
 
+    /**
+     * load player stuff from yml
+     * @param player
+     * @throws IOException
+     */
     public void loadUsingYml(Player player) throws IOException {
         FileConfiguration config = sto.createYml(player);
         attributes.setAttributes(player, config.getInt("maxHealth"), config.getInt("health"), config.getInt("itemHealth"),
@@ -183,6 +209,10 @@ public class PlayerConfig {
         playerManager.getRaxenPlayer(player).setInventory(inv);
     }
 
+    /**
+     * saves player stuff
+     * @param player
+     */
     public void savePlayerConfig(@NotNull Player player) {
         Attributes attributes = new Attributes(main);
         Inventory inv = player.getInventory();
@@ -225,6 +255,10 @@ public class PlayerConfig {
         debug(main, "Player: " + player.getName() + " data successfully saved!");
     }
 
+    /**
+     * load player stuff
+     * @param player
+     */
     public void loadPlayerConfig(Player player) {
         String st = StorageManager.getConfig().getString("storage");
         String value = "";
diff --git a/src/main/java/gq/unurled/raxen/listener/entity/DamageEntity.java b/src/main/java/gq/unurled/raxen/listener/entity/DamageEntity.java
index 1a745d1..875d2eb 100644
--- a/src/main/java/gq/unurled/raxen/listener/entity/DamageEntity.java
+++ b/src/main/java/gq/unurled/raxen/listener/entity/DamageEntity.java
@@ -27,6 +27,11 @@ public class DamageEntity implements Listener {
         this.entityNamespacedKey = new EntityNamespacedKey(main);
     }
 
+    /**
+     * fired when an entity is damaged by another entity
+     * calculates the damage and apply it to the entity
+     * @param e
+     */
     @EventHandler
     public void entityDamageByEntity(EntityDamageByEntityEvent e) {
         if (!(e.getEntity() instanceof LivingEntity) || !(e.getDamager() instanceof LivingEntity)) {
@@ -110,6 +115,10 @@ public class DamageEntity implements Listener {
         }
     }
 
+    /**
+     * damage made by blocks on entity
+     * @param e
+     */
     @EventHandler
     public void entityDamageByBlock(EntityDamageByBlockEvent e) {
         e.setDamage(0);
diff --git a/src/main/java/gq/unurled/raxen/listener/entity/SpawnEvent.java b/src/main/java/gq/unurled/raxen/listener/entity/SpawnEvent.java
index e5e5566..f20ac96 100644
--- a/src/main/java/gq/unurled/raxen/listener/entity/SpawnEvent.java
+++ b/src/main/java/gq/unurled/raxen/listener/entity/SpawnEvent.java
@@ -25,10 +25,15 @@ public class SpawnEvent implements Listener {
         this.namespacedKey = new EntityNamespacedKey(main);
     }
 
+    /**
+     * when a new entity spawns
+     * adds all persistent data container
+     * @param e
+     */
     @EventHandler
     public void Spawn(EntitySpawnEvent e) {
         if (e.getEntity() instanceof Player) {
-            //player stuff dont want to talk about it;
+            //player stuff dont want to talk about it; already doing it in player join event
             debug(main, "Player: " + ((Player) e.getEntity()).getName());
         } else if (e.getEntity().getType() != EntityType.DROPPED_ITEM && e.getEntity().getType() != EntityType.FALLING_BLOCK) {
             debug(main, e.getEntity().getName());
diff --git a/src/main/java/gq/unurled/raxen/listener/player/ArmorEvent.java b/src/main/java/gq/unurled/raxen/listener/player/ArmorEvent.java
index 285ab4f..2621171 100644
--- a/src/main/java/gq/unurled/raxen/listener/player/ArmorEvent.java
+++ b/src/main/java/gq/unurled/raxen/listener/player/ArmorEvent.java
@@ -22,6 +22,10 @@ public class ArmorEvent implements Listener {
         this.main = main;
     }
 
+    /**
+     * when player changes armor, calculates new stats for player and setting it
+     * @param e
+     */
     @EventHandler
     public void ArmorChangeEvent(PlayerArmorChangeEvent e) {
         Player player = e.getPlayer();
diff --git a/src/main/java/gq/unurled/raxen/listener/player/ClickBlockEvent.java b/src/main/java/gq/unurled/raxen/listener/player/ClickBlockEvent.java
index d30c8ca..f1d8082 100644
--- a/src/main/java/gq/unurled/raxen/listener/player/ClickBlockEvent.java
+++ b/src/main/java/gq/unurled/raxen/listener/player/ClickBlockEvent.java
@@ -21,6 +21,10 @@ public class ClickBlockEvent implements Listener {
         this.gui = new GUI(main);
     }
 
+    /**
+     * use with guis
+     * @param e
+     */
     @EventHandler
     public void ClickEvent(PlayerInteractEvent e) {
         Player player = e.getPlayer();
diff --git a/src/main/java/gq/unurled/raxen/listener/player/CloseInventoryEvent.java b/src/main/java/gq/unurled/raxen/listener/player/CloseInventoryEvent.java
index 6e35ecb..2a37949 100644
--- a/src/main/java/gq/unurled/raxen/listener/player/CloseInventoryEvent.java
+++ b/src/main/java/gq/unurled/raxen/listener/player/CloseInventoryEvent.java
@@ -15,6 +15,10 @@ public class CloseInventoryEvent implements Listener {
 
     private PlayerManager playerManager;
 
+    /**
+     * save enderchest/storage when player close
+     * @param e
+     */
     @EventHandler
     public void InventoryCloseEvent(InventoryCloseEvent e) {
         Player player = (Player) e.getPlayer();
diff --git a/src/main/java/gq/unurled/raxen/listener/player/ItemHandEvent.java b/src/main/java/gq/unurled/raxen/listener/player/ItemHandEvent.java
index 42861b0..136bcf2 100644
--- a/src/main/java/gq/unurled/raxen/listener/player/ItemHandEvent.java
+++ b/src/main/java/gq/unurled/raxen/listener/player/ItemHandEvent.java
@@ -22,6 +22,10 @@ public class ItemHandEvent implements Listener {
         this.main = main;
     }
 
+    /**
+     * when player have something in hand, change and add new stats
+     * @param e
+     */
     @EventHandler
     public void ItemHeldEvent(PlayerItemHeldEvent e) {
         Player player = e.getPlayer();
diff --git a/src/main/java/gq/unurled/raxen/listener/player/JoinEvent.java b/src/main/java/gq/unurled/raxen/listener/player/JoinEvent.java
index 2a177b7..cbb2a6b 100644
--- a/src/main/java/gq/unurled/raxen/listener/player/JoinEvent.java
+++ b/src/main/java/gq/unurled/raxen/listener/player/JoinEvent.java
@@ -26,6 +26,10 @@ public class JoinEvent implements Listener {
         this.playerManager = main.getManager().getPlayerManager();
     }
 
+    /**
+     * when player joins, load from config all stats
+     * @param e
+     */
     @EventHandler
     public void PlayerJoinEvent(PlayerJoinEvent e) {
         Player player = e.getPlayer();
diff --git a/src/main/java/gq/unurled/raxen/listener/player/LeaveEvent.java b/src/main/java/gq/unurled/raxen/listener/player/LeaveEvent.java
index dd74822..3eb4281 100644
--- a/src/main/java/gq/unurled/raxen/listener/player/LeaveEvent.java
+++ b/src/main/java/gq/unurled/raxen/listener/player/LeaveEvent.java
@@ -21,6 +21,11 @@ public class LeaveEvent implements Listener {
 
     }
 
+    /**
+     * when player leaves, saves everything
+     * @param e
+     * @throws IOException
+     */
     @EventHandler
     public void PlayerLeaveEvent(PlayerQuitEvent e) throws IOException {
         Player player = e.getPlayer();
diff --git a/src/main/java/gq/unurled/raxen/listener/player/ServerPingEvent.java b/src/main/java/gq/unurled/raxen/listener/player/ServerPingEvent.java
index 38e24f8..56e6667 100644
--- a/src/main/java/gq/unurled/raxen/listener/player/ServerPingEvent.java
+++ b/src/main/java/gq/unurled/raxen/listener/player/ServerPingEvent.java
@@ -22,6 +22,10 @@ public class ServerPingEvent implements Listener {
         this.loading = true;
     }
 
+    /**
+     * set the motd
+     * @param e
+     */
     @EventHandler
     public void ServerListPingEvent(ServerListPingEvent e) {
         FileConfiguration config = this.main.getConfig();
diff --git a/src/main/java/gq/unurled/raxen/listener/player/TransactionEvent.java b/src/main/java/gq/unurled/raxen/listener/player/TransactionEvent.java
index c871ff3..a107d59 100644
--- a/src/main/java/gq/unurled/raxen/listener/player/TransactionEvent.java
+++ b/src/main/java/gq/unurled/raxen/listener/player/TransactionEvent.java
@@ -20,6 +20,10 @@ public class TransactionEvent implements Listener {
         this.vault = main.getManager().getLibsManager().getVault();
     }
 
+    /**
+     * set scoreboard when money changes
+     * @param e
+     */
     @EventHandler
     public void transaction(net.essentialsx.api.v2.events.TransactionEvent e) {
         Player player = Bukkit.getPlayer(e.getTarget().getName());
diff --git a/src/main/java/gq/unurled/raxen/manager/entity/EntityManager.java b/src/main/java/gq/unurled/raxen/manager/entity/EntityManager.java
index 82052a1..bbc8569 100644
--- a/src/main/java/gq/unurled/raxen/manager/entity/EntityManager.java
+++ b/src/main/java/gq/unurled/raxen/manager/entity/EntityManager.java
@@ -36,6 +36,11 @@ public class EntityManager {
 
     }
 
+    /**
+     * used to register entities using fileconfigs but rapidly abandoned
+     * @param file
+     */
+    @Deprecated
     public void registerEntityFromConfig(FileConfiguration file) {
         debug(file.getString("id"));
         World world = Bukkit.getWorld(file.getString("world"));
diff --git a/src/main/java/gq/unurled/raxen/manager/entity/ItemManager.java b/src/main/java/gq/unurled/raxen/manager/entity/ItemManager.java
index d4be3cd..156c94e 100644
--- a/src/main/java/gq/unurled/raxen/manager/entity/ItemManager.java
+++ b/src/main/java/gq/unurled/raxen/manager/entity/ItemManager.java
@@ -36,6 +36,10 @@ public class ItemManager {
         // register();
     }
 
+    /**
+     * Old system to register all items in the /items/ folder
+     */
+    @Deprecated
     private void register() {
         File folder = new File(main.getDataFolder() + "/Items/");
         File[] listFile = folder.listFiles();
@@ -68,6 +72,11 @@ public class ItemManager {
         }
     }
 
+    /**
+     * Old system to register for a file config an item inside.
+     * @param file
+     */
+    @Deprecated
     private void registerItem(@NotNull FileConfiguration file) {
         debug(main, file.getString("id"));
         ItemStack it = new ItemStack(Objects.requireNonNull(Material.getMaterial((String) Objects.requireNonNull(file.get("id")))));
diff --git a/src/main/java/gq/unurled/raxen/manager/entity/PlayerManager.java b/src/main/java/gq/unurled/raxen/manager/entity/PlayerManager.java
index c5232b8..7b167b5 100644
--- a/src/main/java/gq/unurled/raxen/manager/entity/PlayerManager.java
+++ b/src/main/java/gq/unurled/raxen/manager/entity/PlayerManager.java
@@ -47,6 +47,10 @@ public class PlayerManager {
         return new RaxenPlayer(main, player);
     }
 
+    /**
+     * add a task to the player action bar.
+     * @param player
+     */
     public void registerActionBar(Player player) {
         PlayerManager pm = main.getManager().getPlayerManager();
          BukkitTask task = new BukkitRunnable() {
@@ -62,6 +66,10 @@ public class PlayerManager {
          }
     }
 
+    /**
+     * removes the task of action bar to player
+     * @param player
+     */
     public void unRegisterActionBar(Player player) {
         if(actionBar.containsKey(player.getUniqueId())) {
             BukkitTask task = actionBar.get(player.getUniqueId());
diff --git a/src/main/java/gq/unurled/raxen/manager/entity/StorageManager.java b/src/main/java/gq/unurled/raxen/manager/entity/StorageManager.java
index 2ddfdf7..dc0fcf4 100644
--- a/src/main/java/gq/unurled/raxen/manager/entity/StorageManager.java
+++ b/src/main/java/gq/unurled/raxen/manager/entity/StorageManager.java
@@ -34,6 +34,9 @@ public class StorageManager {
         this.connect();
     }
 
+    /**
+     * Connects to the storage system (MONGO, YML, MYSQL (not implemented))
+     */
     public static void connect() {
         String s = (String) config.get("storage");
         debug(main, s);
@@ -49,10 +52,18 @@ public class StorageManager {
         }
     }
 
+    /**
+     * disconnect mysql db
+     */
     public static void disconnect() {
         mysql.disconnect();
     }
 
+    /**
+     * create a new yml for the player
+     * @param player
+     * @return the created yml
+     */
     public static @NotNull FileConfiguration createYml(@NotNull Player player) {
         File customFile;
         FileConfiguration customConfig;
@@ -97,6 +108,11 @@ public class StorageManager {
         return customConfig;
     }
 
+    /**
+     * create a config yaml with the file
+     * @param file
+     * @return a file configuration
+     */
     public static @NotNull FileConfiguration createYml(@NotNull File file) {
 
         FileConfiguration customConfig;
@@ -120,6 +136,11 @@ public class StorageManager {
         return customConfig;
     }
 
+    /**
+     * create a config in the path provided
+     * @param path
+     * @return the created config file
+     */
     public static @NotNull FileConfiguration createYml(String path) {
         File customFile;
         FileConfiguration customConfig;
diff --git a/src/main/java/gq/unurled/raxen/manager/server/CommandManager.java b/src/main/java/gq/unurled/raxen/manager/server/CommandManager.java
index a9ff63f..34b8262 100644
--- a/src/main/java/gq/unurled/raxen/manager/server/CommandManager.java
+++ b/src/main/java/gq/unurled/raxen/manager/server/CommandManager.java
@@ -33,6 +33,9 @@ public class CommandManager {
         this.raxenCommand = new RaxenCommand(main);
     }
 
+    /**
+     * register/add all the plugin's command
+     */
     public void register() {
         main.getCommand("reloadplugin").setExecutor(reloadComand);
         main.getCommand("reloadplugin").setTabCompleter(reloadComand);
diff --git a/src/main/java/gq/unurled/raxen/manager/server/DungeonsManager.java b/src/main/java/gq/unurled/raxen/manager/server/DungeonsManager.java
index 2b955d6..afc98f5 100644
--- a/src/main/java/gq/unurled/raxen/manager/server/DungeonsManager.java
+++ b/src/main/java/gq/unurled/raxen/manager/server/DungeonsManager.java
@@ -21,6 +21,9 @@ public class DungeonsManager {
         registerDungeons();
     }
 
+    /**
+     * register/add all made dungeon to the available plugin list
+     */
     public void registerDungeons() {
         ForestDungeon forestDungeon = new ForestDungeon();
         dungeons.put("FOREST", forestDungeon);
diff --git a/src/main/java/gq/unurled/raxen/listener/player/EnchantmentManager.java b/src/main/java/gq/unurled/raxen/manager/server/EnchantmentManager.java
similarity index 92%
rename from src/main/java/gq/unurled/raxen/listener/player/EnchantmentManager.java
rename to src/main/java/gq/unurled/raxen/manager/server/EnchantmentManager.java
index 2c52dd0..91caadb 100644
--- a/src/main/java/gq/unurled/raxen/listener/player/EnchantmentManager.java
+++ b/src/main/java/gq/unurled/raxen/manager/server/EnchantmentManager.java
@@ -1,10 +1,11 @@
-package gq.unurled.raxen.listener.player;
+package gq.unurled.raxen.manager.server;
 
 import org.bukkit.enchantments.Enchantment;
 
 import java.lang.reflect.Field;
 
 public class EnchantmentManager {
+
     public static void registerEnchantment(Enchantment enchantment) {
         boolean registered = true;
         try {
diff --git a/src/main/java/gq/unurled/raxen/manager/server/ListenerManager.java b/src/main/java/gq/unurled/raxen/manager/server/ListenerManager.java
index 9431a81..322ae54 100644
--- a/src/main/java/gq/unurled/raxen/manager/server/ListenerManager.java
+++ b/src/main/java/gq/unurled/raxen/manager/server/ListenerManager.java
@@ -21,6 +21,9 @@ public class ListenerManager {
         this.serverPingEvent = new ServerPingEvent(main);
     }
 
+    /**
+     * register/addd listener events
+     */
     public void register() {
         this.pm.registerEvents(new JoinEvent(main), main);
         this.pm.registerEvents(new LeaveEvent(main), main);
diff --git a/src/main/java/gq/unurled/raxen/manager/server/ResourcePackManager.java b/src/main/java/gq/unurled/raxen/manager/server/ResourcePackManager.java
index fb17278..758e6f0 100644
--- a/src/main/java/gq/unurled/raxen/manager/server/ResourcePackManager.java
+++ b/src/main/java/gq/unurled/raxen/manager/server/ResourcePackManager.java
@@ -27,6 +27,9 @@ public class ResourcePackManager {
         enable();
     }
 
+    /**
+     * Method to enable the ressourcpack
+     */
     private void enable() {
         if(useRP) {
             if(config.getString("resource_pack_url") == null || Objects.equals(config.getString("rssource_pack_url"), "") ||
diff --git a/src/main/java/gq/unurled/raxen/manager/server/WorldManager.java b/src/main/java/gq/unurled/raxen/manager/server/WorldManager.java
index 21ae63a..4705979 100644
--- a/src/main/java/gq/unurled/raxen/manager/server/WorldManager.java
+++ b/src/main/java/gq/unurled/raxen/manager/server/WorldManager.java
@@ -58,6 +58,9 @@ public class WorldManager {
         }
     }
 
+    /**
+     * load all world in the worlds folder
+     */
     public void load() {
         if (!pluginFolder.exists()) {
             pluginFolder.mkdirs();
@@ -86,6 +89,10 @@ public class WorldManager {
         }
     }
 
+    /**
+     * load world from the name of it
+     * @param name
+     */
     public void loadWorld(String name) {
         File world = new File(pluginFolder + "/" + name + "/");
         if (!world.exists() || !world.isDirectory()) {