Allows some items to not trigger a hand/crosshair update.

This is helpful if one is using Firework rockets to fly around the landscape.

src/main/java/markil3/immersive_hud/ConfigManager.java

@@ -1,11 +1,19 @@
 package markil3.immersive_hud;
 
+import net.minecraft.item.Item;
+import net.minecraft.item.Items;
+import net.minecraft.util.Identifier;
 import net.minecraft.util.math.MathHelper;
+import net.minecraft.util.registry.Registry;
 
 import me.shedaniel.autoconfig.AutoConfig;
 
 import static markil3.immersive_hud.Main.TICKS_PER_SECOND;
 
+import java.util.Arrays;
+import java.util.Set;
+import java.util.stream.Collectors;
+
 /**
  * Configuration manager of this mod, which reads from and writes to this mod's
  * configuration file.
@@ -88,6 +96,7 @@ public class ConfigManager
     private boolean showArmor = true;
     private double minHealth = 0.5;
     private int minHunger = 17;
+    private Identifier[] ignoredItems = new Identifier[]{Registry.ITEM.getId(Items.FIREWORK_ROCKET)};
 
     /**
      * Returns the instance of this class.
@@ -247,6 +256,26 @@ public class ConfigManager
         return this.minHunger;
     }
 
+    /**
+     * Obtains a collection of items that won't cause hands and crosshairs to show when used.
+     *
+     * @return A set of ignored items.
+     */
+    public Set<Item> getIgnoredItems()
+    {
+        return Arrays.stream(ignoredItems).map(Registry.ITEM::get).collect(Collectors.toSet());
+    }
+
+    /**
+     * Obtains a collection of items that won't cause hands and crosshairs to show when used.
+     *
+     * @return An array of identifiers.
+     */
+    public Identifier[] getIgnoredIdentifiers()
+    {
+        return this.ignoredItems;
+    }
+
     /**
      * Sets the time that the hands are allowed to display.
      *
@@ -318,6 +347,26 @@ public class ConfigManager
     {
         this.minHunger = MathHelper.clamp(boundary, 0, 20);
     }
+
+    /**
+     * Sets which items won't cause the hands and crosshairs to show when used.
+     *
+     * @param items - A set of ignored items.
+     */
+    public void setIgnoredItems(Item... items)
+    {
+        this.ignoredItems = Arrays.stream(items).map(Registry.ITEM::getId).toArray(Identifier[]::new);
+    }
+
+    /**
+     * Sets which items won't cause the hands and crosshairs to show when used.
+     *
+     * @param items - A set of ignored items.
+     */
+    public void setIgnoredItems(String... items)
+    {
+        this.ignoredItems = Arrays.stream(items).map(Identifier::new).filter(i -> Registry.ITEM.getOrEmpty(i).isPresent()).toArray(Identifier[]::new);
+    }
 /**
      * Saves changes to this mod's configuration.
      */

src/main/java/markil3/immersive_hud/ModMenu.java

@@ -3,7 +3,11 @@ package markil3.immersive_hud;
 import com.terraformersmc.modmenu.api.ConfigScreenFactory;
 import com.terraformersmc.modmenu.api.ModMenuApi;
 
+import net.minecraft.item.Items;
 import net.minecraft.text.TranslatableText;
+import net.minecraft.util.Identifier;
+import net.minecraft.util.InvalidIdentifierException;
+import net.minecraft.util.registry.Registry;
 
 import me.shedaniel.autoconfig.AutoConfig;
 import me.shedaniel.clothconfig2.api.ConfigBuilder;
@@ -13,6 +17,11 @@ import me.shedaniel.clothconfig2.gui.entries.DoubleListEntry;
 
 import static markil3.immersive_hud.Main.TICKS_PER_SECOND;
 
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
 public class ModMenu implements ModMenuApi
 {
 
@@ -35,7 +44,8 @@ public class ModMenu implements ModMenuApi
                             .setTooltip(new TranslatableText(
                                     "tooltip.immersive_hud." + name +
                                             "MaxTime"))
-                        .setSaveConsumer(val -> value.setMaxTime((int) (val * TICKS_PER_SECOND)))
+                            .setSaveConsumer(val -> value
+                                    .setMaxTime((int) (val * TICKS_PER_SECOND)))
                             .build();
 
         DoubleListEntry fadeIn =
@@ -49,7 +59,8 @@ public class ModMenu implements ModMenuApi
                             .setTooltip(new TranslatableText(
                                     "tooltip.immersive_hud." + name +
                                             "FadeIn"))
-                        .setSaveConsumer(val -> value.setFadeInTime((int) (val * TICKS_PER_SECOND)))
+                            .setSaveConsumer(val -> value
+                                    .setFadeInTime((int) (val * TICKS_PER_SECOND)))
                             .build();
 
         DoubleListEntry fadeOut =
@@ -63,7 +74,8 @@ public class ModMenu implements ModMenuApi
                             .setTooltip(new TranslatableText(
                                     "tooltip.immersive_hud." + name +
                                             "FadeOut"))
-                        .setSaveConsumer(val -> value.setFadeOutTime((int) (val * TICKS_PER_SECOND)))
+                            .setSaveConsumer(val -> value
+                                    .setFadeOutTime((int) (val * TICKS_PER_SECOND)))
                             .build();
 
         cat.addEntry(maxTime);
@@ -85,9 +97,11 @@ public class ModMenu implements ModMenuApi
                                                        .setSavingRunnable(() -> {
                                                            try
                                                            {
-                            if (Class.forName("me.shedaniel.autoconfig.AutoConfig") != null)
+                                                               if (Class
+                                                                       .forName("me.shedaniel.autoconfig.AutoConfig") != null)
                                                                {
-                                AutoConfig.getConfigHolder(ConfigManagerCloth.class)
+                                                                   AutoConfig
+                                                                           .getConfigHolder(ConfigManagerCloth.class)
                                                                            .save();
                                                                }
                                                            }
@@ -128,7 +142,8 @@ public class ModMenu implements ModMenuApi
                                          .setTooltip(new TranslatableText(
                                                  "tooltip.immersive_hud" +
                                                          ".crosshairTime"))
-                    .setSaveConsumer(val -> instance.setCrosshairTime((int) (val * TICKS_PER_SECOND)))
+                                         .setSaveConsumer(val -> instance
+                                                 .setCrosshairTime((int) (val * TICKS_PER_SECOND)))
                                          .build());
 
             general.addEntry(entryBuilder.startBooleanToggle(new TranslatableText(
@@ -146,7 +161,8 @@ public class ModMenu implements ModMenuApi
                                          .setDefaultValue(30)
                                          .setTooltip(new TranslatableText(
                                                  "tooltip.immersive_hud.handTime"))
-                    .setSaveConsumer(val -> instance.setHandTime((int) (val * TICKS_PER_SECOND)))
+                                         .setSaveConsumer(val -> instance
+                                                 .setHandTime((int) (val * TICKS_PER_SECOND)))
                                          .build());
 
             general.addEntry(entryBuilder.startBooleanToggle(new TranslatableText(
@@ -185,6 +201,31 @@ public class ModMenu implements ModMenuApi
                                          .setSaveConsumer(val -> instance.shouldShowArmor(val))
                                          .build());
 
+            general.addEntry(entryBuilder
+                    .startStrList(new TranslatableText("option.immersive_hud.ignoreList"), Arrays
+                            .asList(instance
+                                    .getIgnoredIdentifiers()).stream().map(Identifier::toString)
+                            .collect(Collectors.toList()))
+                    .setDefaultValue(Arrays
+                            .asList(Registry.ITEM.getId(Items.FIREWORK_ROCKET).toString()))
+                    .setTooltip(new TranslatableText("tooltip.immersive_hud.ignoreList"))
+                    .setSaveConsumer(val -> instance.setIgnoredItems(val.toArray(new String[0]))).setErrorSupplier(val -> {
+                        try
+                        {
+                            Optional<String> item = val.stream().filter(i -> !Registry.ITEM.getOrEmpty(new Identifier(i)).isPresent()).findFirst();
+                            if (item.isPresent())
+                            {
+                                return Optional.of(new TranslatableText("error.immersive_hud.ignoreList.unknownItem"));
+                            }
+                        }
+                        catch (InvalidIdentifierException e)
+                        {
+                            return Optional.of(new TranslatableText("error.immersive_hud.ignoreList.illegalId"));
+                        }
+                        return Optional.empty();
+                    })
+                    .build());
+
             return builder.build();
         };
     }

src/main/java/markil3/immersive_hud/TimerUtils.java

@@ -49,6 +49,7 @@ import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.Optional;
+import java.util.Set;
 
 /**
  * Contains the logic for changing the HUD.
@@ -289,7 +290,6 @@ public class TimerUtils
      *
      * @param hand  - The hand being triggered
      * @param clear - Whether the hand it being enabled or disabled.
-     *
      * @since 0.1-1.16.4-fabric
      */
     public static void onClick(Hand hand, boolean clear)
@@ -304,6 +304,7 @@ public class TimerUtils
         LivingEntity entity;
         Item item;
         Iterator<ItemStack> hands;
+        Set<Item> ignored;
         if (mc.getCameraEntity() instanceof LivingEntity)
         {
             entity = (LivingEntity) mc.getCameraEntity();
@@ -329,6 +330,14 @@ public class TimerUtils
                             .map(ItemStack::getItem)
                             .orElse(null);
         }
+        if (item != null)
+        {
+            ignored = ConfigManager.getInstance().getIgnoredItems();
+            if (ignored.contains(item))
+            {
+                return;
+            }
+        }
         crosshairTime = ConfigManager.getInstance().getCrosshairTime();
         if (hand == Hand.MAIN_HAND)
         {
@@ -364,9 +373,7 @@ public class TimerUtils
      *
      * @param hand        - The hand being rendered.
      * @param matrixStack - The rendering stack.
-     *
      * @return If true, then don't render this hand at all.
-     *
      * @since 0.1-1.16.4-fabric
      */
     public static boolean onRenderHand(Hand hand,
@@ -432,7 +439,6 @@ public class TimerUtils
      * needed.
      *
      * @return If true, then cancel drawing the crosshair.
-     *
      * @since 0.1-1.16.4-fabric
      */
     public static boolean drawCrosshair(float ticks)
@@ -489,7 +495,6 @@ public class TimerUtils
      * as needed.
      *
      * @return If true, then cancel drawing the mount health bar.
-     *
      * @since 0.1-1.16.4-fabric
      */
     public static boolean drawMountHealth(MatrixStack stack, float ticks)
@@ -621,7 +626,6 @@ public class TimerUtils
      * Obtains how transparent
      *
      * @param effectinstance
-     *
      * @return
      */
     public static float getPotionAlpha(StatusEffectInstance effectinstance)
@@ -633,7 +637,8 @@ public class TimerUtils
         if (effectinstance.getDuration() <= BLINK_TIME)
         {
             effectAlpha =
-                    MathHelper.sin(7000F / (effectinstance.getDuration() + 16F * (float) Math.PI)) * 50F / (effectinstance
+                    MathHelper.sin(7000F / (effectinstance
+                            .getDuration() + 16F * (float) Math.PI)) * 50F / (effectinstance
                             .getDuration() + 100F) + 0.5F;
         }
         else if (effectinstance.getDuration() <= BLINK_TIME + potion.getFadeInTime())
@@ -658,7 +663,6 @@ public class TimerUtils
      * needed.
      *
      * @return If true, then cancel drawing the armor bar.
-     *
      * @since 0.1-1.16.4-fabric
      */
     public static boolean drawArmor()
@@ -686,7 +690,6 @@ public class TimerUtils
      * needed.
      *
      * @return If true, then cancel drawing the health.
-     *
      * @since 0.1-1.16.4-fabric
      */
     public static boolean drawHealth(float ticks)
@@ -762,7 +765,6 @@ public class TimerUtils
      * needed.
      *
      * @return If true, then cancel drawing the hunger bar.
-     *
      * @since 0.1-1.16.4-fabric
      */
     public static boolean drawHunger(float ticks)
@@ -841,9 +843,7 @@ public class TimerUtils
      * as needed.
      *
      * @param stack
-     *
      * @return If true, then cancel drawing the jump bar.
-     *
      * @since 0.1-1.16.4-fabric
      */
     public static boolean drawJumpbar(MatrixStack stack, float ticks)
@@ -890,7 +890,6 @@ public class TimerUtils
      * as needed.
      *
      * @return If true, then cancel drawing the experience bar.
-     *
      * @since 0.1-1.16.4-fabric
      */
     public static boolean drawExperience(MatrixStack stack, float ticks)
@@ -945,7 +944,6 @@ public class TimerUtils
      * or not to draw it.
      *
      * @return If true, then cancel drawing the hotbar.
-     *
      * @see #recolorHotbar(MatrixStack)
      * @since 0.1-1.16.4-fabric
      */
@@ -1166,7 +1164,6 @@ public class TimerUtils
      * needed.
      *
      * @return If true, then cancel drawing the crosshair.
-     *
      * @since 0.1-1.16.4-fabric
      */
     public static void recolorHotbar(MatrixStack stack)

src/main/resources/assets/immersive_hud/lang/en_us.json

@@ -25,6 +25,7 @@
   "option.immersive_hud.minHealth": "Minimum Health Fade",
   "option.immersive_hud.minHunger": "Minimum Hunger Fade",
   "option.immersive_hud.showArmor": "Show Armor",
+  "option.immersive_hud.ignoreList": "Ignored Items",
   "tooltip.immersive_hud.hotbarMaxTime": "How long the hotbar can be displayed on screen in seconds",
   "tooltip.immersive_hud.hotbarFadeIn": "How many seconds it takes for the hotbar to fade in",
   "tooltip.immersive_hud.hotbarFadeOut": "How many seconds it takes for the hotbar to move out",
@@ -49,5 +50,8 @@
   "tooltip.immersive_hud.hideHands": "Whether or not hands should be hidden after a period of time",
   "tooltip.immersive_hud.minHealth": "When the percentage of health goes below this level, the health bar won't fade away",
   "tooltip.immersive_hud.minHunger": "When the hunger level goes below this level, the hunger bar won't fade away",
-  "tooltip.immersive_hud.showArmor": "Whether or not the armor bar should display on the HUD"
+  "tooltip.immersive_hud.showArmor": "Whether or not the armor bar should display on the HUD",
+  "tooltip.immersive_hud.ignoreList": "Which items will not trigger the arm and crosshairs when used",
+  "error.immersive_hud.ignoreList.unknownItem": "Unknown item %s",
+  "error.immersive_hud.ignoreList.illegalId": "%s is not a legal item identifier"
 }