Add few comments

zrdzn · Apr 23, 2022 · 0c70724 · 0c70724
1 parent 87a7af0
commit 0c70724
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 1 deletion.
diff --git a/plugin/src/main/java/io/github/zrdzn/minecraft/lovelydrop/drop/DropCommand.java b/plugin/src/main/java/io/github/zrdzn/minecraft/lovelydrop/drop/DropCommand.java
@@ -36,6 +36,7 @@ public DropCommand(MessageParser messageParser, MenuService menuService) {
     @Override
     public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label,
                              String[] args) {
+        // Check if sender is console.
         if (!(sender instanceof Player)) {
             sender.sendMessage(this.messageParser.getExecutedAsConsole());
             return true;
@@ -48,6 +49,7 @@ public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command
             return true;
         }
 
+        // Try to open the inventory.
         if (!this.menuService.open(player)) {
             player.sendMessage(this.messageParser.getMenuOpenError());
             return true;

diff --git a/plugin/src/main/java/io/github/zrdzn/minecraft/lovelydrop/drop/DropListener.java b/plugin/src/main/java/io/github/zrdzn/minecraft/lovelydrop/drop/DropListener.java
@@ -52,11 +52,13 @@ public void onSourceBreak(BlockBreakEvent event) {
 
         Material source = event.getBlock().getType();
 
+        // Get optional drops from source blocks.
         Set<Item> sourceDrops = this.itemCache.getDrops(source);
         if (sourceDrops.isEmpty()) {
             return;
         }
 
+        // Get user from the cache.
         Optional<User> userMaybe = this.userCache.getUser(player.getUniqueId());
         if (!userMaybe.isPresent()) {
             this.logger.severe("User " + player.getName() + " is not added to cached users.");
@@ -67,6 +69,7 @@ public void onSourceBreak(BlockBreakEvent event) {
 
         User user = userMaybe.get();
 
+        // Remove all disabled drops from the source drops list.
         sourceDrops.removeIf(sourceDrop -> user.getDisabledDrops().contains(sourceDrop));
 
         ThreadLocalRandom random = ThreadLocalRandom.current();
@@ -97,6 +100,7 @@ public void onSourceBreak(BlockBreakEvent event) {
 
             Map<Integer, ItemStack> itemsLeft = player.getInventory().addItem(droppedItem);
 
+            // Drop items on the floor if player has full inventory.
             itemsLeft.forEach((key, value) ->
                 player.getWorld().dropItemNaturally(player.getEyeLocation(), value));
         });

diff --git a/plugin/src/main/java/io/github/zrdzn/minecraft/lovelydrop/item/ItemParser.java b/plugin/src/main/java/io/github/zrdzn/minecraft/lovelydrop/item/ItemParser.java
@@ -120,6 +120,7 @@ public List<Item> parseMany(ConfigurationSection section) throws InvalidConfigur
 
         List<Item> items = new ArrayList<>();
 
+        // Add each item section to items list.
         section.getKeys(false).forEach(key -> {
             try {
                 items.add(this.parse(section.getConfigurationSection(key)));

diff --git a/plugin/src/main/java/io/github/zrdzn/minecraft/lovelydrop/menu/MenuItemParser.java b/plugin/src/main/java/io/github/zrdzn/minecraft/lovelydrop/menu/MenuItemParser.java
@@ -81,6 +81,7 @@ public List<MenuItem> parseMany(ConfigurationSection section) throws InvalidConf
 
         List<MenuItem> items = new ArrayList<>();
 
+        // Add each item section to items list.
         section.getKeys(false).forEach(key -> {
             try {
                 items.add(this.parse(section.getConfigurationSection(key)));

diff --git a/plugin/src/main/java/io/github/zrdzn/minecraft/lovelydrop/menu/MenuService.java b/plugin/src/main/java/io/github/zrdzn/minecraft/lovelydrop/menu/MenuService.java
@@ -45,6 +45,7 @@ public MenuService(Logger logger, Menu menu, UserCache userCache) {
     }
 
     public boolean open(Player player) {
+        // Try getting user from the cache.
         Optional<User> userMaybe = this.userCache.getUser(player.getUniqueId());
         if (!userMaybe.isPresent()) {
             this.logger.severe("User " + player.getName() + " is not added to cached users.");
@@ -55,13 +56,15 @@ public boolean open(Player player) {
 
         Gui menu = new Gui(this.menu.getRows(), this.menu.getTitle(), InteractionModifier.VALUES);
 
+        // Forbid the player from getting the item from the inventory.
         menu.setDefaultClickAction(event -> event.setCancelled(true));
 
         this.menu.getItems().forEach(item -> {
             Entry<Integer, Integer> slot = item.getSlot();
             int row = slot.getKey();
             int column = slot.getValue();
 
+            // Set item that does not have drop item assigned to it.
             Item dropItem = item.getDropItem();
             if (dropItem == null) {
                 menu.setItem(row, column, ItemBuilder.from(item.getType())
@@ -82,6 +85,7 @@ public boolean open(Player player) {
 
             Entry<String, String> amountFormat = this.menu.getAmountFormat();
 
+            // Set lore depending on the amount setting.
             List<String> lore = item.getLore().stream()
                 .map(line -> {
                     String finalAmount;
@@ -111,6 +115,7 @@ public boolean open(Player player) {
                     .collect(Collectors.toList()))
                 .asGuiItem();
 
+            // Perform specific actions when player clicks the item.
             menuItem.setAction(event -> {
                 if (item.getAction() == MenuAction.CLOSE_MENU) {
                     menu.close(player, true);
@@ -135,7 +140,7 @@ public boolean open(Player player) {
             menu.setItem(row, column, menuItem);
         });
 
-
+        // Fill the rest inventory with the specified item if enabled.
         MenuFiller filler = this.menu.getFiller();
         if (filler.isEnabled()) {
             ItemStack fillerItem = new ItemStack(filler.getType());