Improve DungeonBlaze.java (#254)

improve DungeonBlaze.java

* add javadoc
* using ArmorStandEntity instead iterating every Entity
* reorganize large methods into clearer multiple smaller methods
* defined outlinecolor as constants

1 files changed, 98 insertions, 55 deletions

diff --git a/src/main/java/me/xmrvizzy/skyblocker/skyblock/dungeon/DungeonBlaze.java b/src/main/java/me/xmrvizzy/skyblocker/skyblock/dungeon/DungeonBlaze.java
index d0dcf1e1..c3e12c3d 100644
--- a/src/main/java/me/xmrvizzy/skyblocker/skyblock/dungeon/DungeonBlaze.java
+++ b/src/main/java/me/xmrvizzy/skyblocker/skyblock/dungeon/DungeonBlaze.java
@@ -9,8 +9,10 @@ import me.xmrvizzy.skyblocker.utils.color.QuadColor;
 import net.fabricmc.fabric.api.client.rendering.v1.WorldRenderContext;
 import net.fabricmc.fabric.api.client.rendering.v1.WorldRenderEvents;
 import net.minecraft.client.MinecraftClient;
+import net.minecraft.client.network.ClientPlayerEntity;
 import net.minecraft.client.world.ClientWorld;
-import net.minecraft.entity.Entity;
+import net.minecraft.entity.decoration.ArmorStandEntity;
+import net.minecraft.predicate.entity.EntityPredicates;
 import net.minecraft.util.math.Box;
 import net.minecraft.util.math.Vec3d;
 import org.slf4j.Logger;
@@ -20,92 +22,133 @@ import java.util.ArrayList;
 import java.util.Comparator;
 import java.util.List;
 
+/**
+ * This class provides functionality to render outlines around Blaze entities
+ */
 public class DungeonBlaze {
     private static final Logger LOGGER = LoggerFactory.getLogger(DungeonBlaze.class.getName());
-    private static final float[] WHITE_COLOR_COMPONENTS = { 1.0f, 1.0f, 1.0f };
-    static Entity highestBlaze = null;
-    static Entity lowestBlaze = null;
-    static Entity nextHighestBlaze = null;
-    static Entity nextLowestBlaze = null;
-    static boolean renderHooked = false;
-    
+    private static final float[] WHITE_COLOR_COMPONENTS = {1.0f, 1.0f, 1.0f};
+    private static final QuadColor outlineColorGreen = QuadColor.single(0.0F, 1.0f, 0.0f, 1f);
+    private static final QuadColor outlineColorWhite = QuadColor.single(1.0f, 1.0f, 1.0f, 1.0f);
+
+    private static ArmorStandEntity highestBlaze = null;
+    private static ArmorStandEntity lowestBlaze = null;
+    private static ArmorStandEntity nextHighestBlaze = null;
+    private static ArmorStandEntity nextLowestBlaze = null;
+    private static boolean renderHooked = false;
+
+    /**
+     * Updates the state of Blaze entities and triggers the rendering process if necessary.
+     */
     public static void update() {
         ClientWorld world = MinecraftClient.getInstance().world;
-        if (world == null || !Utils.isInDungeons()) return;
-        if (!renderHooked){
-
+        ClientPlayerEntity player = MinecraftClient.getInstance().player;
+        if (world == null || player == null || !Utils.isInDungeons()) return;
+        if (!renderHooked) {
             WorldRenderEvents.BEFORE_DEBUG_RENDER.register(DungeonBlaze::blazeRenderer);
             renderHooked = true;
         }
-        Iterable<Entity> entities = world.getEntities();
-        List<ObjectIntPair<Entity>> blazes = new ArrayList<>();
+        List<ObjectIntPair<ArmorStandEntity>> blazes = getBlazesInWorld(world, player);
+        sortBlazes(blazes);
+        updateBlazeEntities(blazes);
+    }
 
-        for (Entity entity : entities) {
-    		String blazeName = entity.getName().getString();
-    		
+    /**
+     * Retrieves Blaze entities in the world and parses their health information.
+     *
+     * @param world The client world to search for Blaze entities.
+     * @return A list of Blaze entities and their associated health.
+     */
+    private static List<ObjectIntPair<ArmorStandEntity>> getBlazesInWorld(ClientWorld world, ClientPlayerEntity player) {
+        List<ObjectIntPair<ArmorStandEntity>> blazes = new ArrayList<>();
+        for (ArmorStandEntity blaze : world.getEntitiesByClass(ArmorStandEntity.class, player.getBoundingBox().expand(500D), EntityPredicates.NOT_MOUNTED)) {
+            String blazeName = blaze.getName().getString();
             if (blazeName.contains("Blaze") && blazeName.contains("/")) {
                 try {
                     int health = Integer.parseInt(blazeName.substring(blazeName.indexOf("/") + 1, blazeName.length() - 1));
-                    
-                	blazes.add(ObjectIntPair.of(entity, health));
-                } catch (NumberFormatException ex) {
-                    ex.printStackTrace();
+                    blazes.add(ObjectIntPair.of(blaze, health));
+                } catch (NumberFormatException e) {
+                    handleException(e);
                 }
             }
         }
+        return blazes;
+    }
 
-        // Order the blazes in the list from the lowest health to the highest health
+    /**
+     * Sorts the Blaze entities based on their health values.
+     *
+     * @param blazes The list of Blaze entities to be sorted.
+     */
+    private static void sortBlazes(List<ObjectIntPair<ArmorStandEntity>> blazes) {
         blazes.sort(Comparator.comparingInt(ObjectIntPair::rightInt));
+    }
 
-        // Ensure that there are blazes in the list
+    /**
+     * Updates information about Blaze entities based on sorted list.
+     *
+     * @param blazes The sorted list of Blaze entities with associated health values.
+     */
+    private static void updateBlazeEntities(List<ObjectIntPair<ArmorStandEntity>> blazes) {
         if (!blazes.isEmpty()) {
             lowestBlaze = blazes.get(0).left();
-
             int highestIndex = blazes.size() - 1;
             highestBlaze = blazes.get(highestIndex).left();
-
-            // If there's more than 1 blaze
             if (blazes.size() > 1) {
-            	nextLowestBlaze = blazes.get(1).left();
-            	nextHighestBlaze = blazes.get(highestIndex - 1).left();
+                nextLowestBlaze = blazes.get(1).left();
+                nextHighestBlaze = blazes.get(highestIndex - 1).left();
             }
         }
-        
     }
+
+    /**
+     * Renders outlines for Blaze entities based on health and position.
+     *
+     * @param wrc The WorldRenderContext used for rendering.
+     */
     public static void blazeRenderer(WorldRenderContext wrc) {
-        QuadColor outlineColorRed = QuadColor.single( 0.0F, 1.0F, 0.0F, 1f);
-        QuadColor outlineColorGreen = QuadColor.single(1.0F, 0.0F, 0.0F, 1f);
-        QuadColor outlineColorWhite = QuadColor.single(1.0f, 1.0f, 1.0f, 1.0f);
-        
         try {
-            if (highestBlaze != null && lowestBlaze != null && highestBlaze.isAlive() && lowestBlaze.isAlive() && SkyblockerConfig.get().locations.dungeons.blazesolver){
-                /* Outline */
+            if (highestBlaze != null && lowestBlaze != null && highestBlaze.isAlive() && lowestBlaze.isAlive() && SkyblockerConfig.get().locations.dungeons.blazesolver) {
                 if (highestBlaze.getY() < 69) {
-                    Box blaze = highestBlaze.getBoundingBox().expand(0.3, 0.9, 0.3).offset(0, -1.1, 0);
-                    RenderUtils.drawBoxOutline(blaze, outlineColorRed, 5f);
-                    
-                    if (nextHighestBlaze != null && nextHighestBlaze.isAlive() && nextHighestBlaze != highestBlaze) {
-                        Box nextBlaze = nextHighestBlaze.getBoundingBox().expand(0.3, 0.9, 0.3).offset(0, -1.1, 0);
-                        RenderUtils.drawBoxOutline(nextBlaze, outlineColorWhite, 5f);
-                        RenderHelper.renderLinesFromPoints(wrc, new Vec3d[] { blaze.getCenter(), nextBlaze.getCenter() }, WHITE_COLOR_COMPONENTS, 1f, 5f);
-                    }
+                    renderBlazeOutline(highestBlaze, nextHighestBlaze, wrc);
                 }
-
-                /* Outline */
                 if (lowestBlaze.getY() > 69) {
-                    Box blaze = lowestBlaze.getBoundingBox().expand(0.3, 0.9, 0.3).offset(0, -1.1, 0);
-                    RenderUtils.drawBoxOutline(blaze, outlineColorRed, 5f);
-                    
-                    if (nextLowestBlaze != null && nextLowestBlaze.isAlive() && nextLowestBlaze != lowestBlaze) {
-                        Box nextBlaze = nextLowestBlaze.getBoundingBox().expand(0.3, 0.9, 0.3).offset(0, -1.1, 0);
-                        RenderUtils.drawBoxOutline(nextBlaze, outlineColorWhite, 5f);
-                        RenderHelper.renderLinesFromPoints(wrc, new Vec3d[] { blaze.getCenter(), nextBlaze.getCenter() }, WHITE_COLOR_COMPONENTS, 1f, 5f);
-                    }
+                    renderBlazeOutline(lowestBlaze, nextLowestBlaze, wrc);
                 }
             }
         } catch (Exception e) {
-            LOGGER.warn("[Skyblocker BlazeRenderer] " + e);
-            e.printStackTrace();
+            handleException(e);
         }
     }
-}
\ No newline at end of file
+
+    /**
+     * Renders outlines for Blaze entities and connections between them.
+     *
+     * @param blaze     The Blaze entity for which to render an outline.
+     * @param nextBlaze The next Blaze entity for connection rendering.
+     * @param wrc       The WorldRenderContext used for rendering.
+     */
+    private static void renderBlazeOutline(ArmorStandEntity blaze, ArmorStandEntity nextBlaze, WorldRenderContext wrc) {
+        Box blazeBox = blaze.getBoundingBox().expand(0.3, 0.9, 0.3).offset(0, -1.1, 0);
+        RenderUtils.drawBoxOutline(blazeBox, DungeonBlaze.outlineColorGreen, 5f);
+
+        if (nextBlaze != null && nextBlaze.isAlive() && nextBlaze != blaze) {
+            Box nextBlazeBox = nextBlaze.getBoundingBox().expand(0.3, 0.9, 0.3).offset(0, -1.1, 0);
+            RenderUtils.drawBoxOutline(nextBlazeBox, DungeonBlaze.outlineColorWhite, 5f);
+
+            Vec3d blazeCenter = blazeBox.getCenter();
+            Vec3d nextBlazeCenter = nextBlazeBox.getCenter();
+
+            RenderHelper.renderLinesFromPoints(wrc, new Vec3d[]{blazeCenter, nextBlazeCenter}, WHITE_COLOR_COMPONENTS, 1f, 5f);
+        }
+    }
+
+    /**
+     * Handles exceptions by logging and printing stack traces.
+     *
+     * @param e The exception to handle.
+     */
+    private static void handleException(Exception e) {
+        LOGGER.warn("[Skyblocker BlazeRenderer] Encountered an unknown exception", e);
+    }
+}