Replace Dot Hints With Number Hints (#52)

As title says, makes the holograms much more readable.

Textures By: bapy_
Original PR By: kstvr32

Supercedes: https://github.com/GTNewHorizons/StructureLib/pull/32

Examples:
<img width="2534" height="1351" alt="image"
src="https://github.com/user-attachments/assets/c24f60b2-d654-4b15-b917-4003141a2b69"
/>
<img width="2538" height="1350" alt="image"
src="https://github.com/user-attachments/assets/a5ca3f42-ca96-4675-8e80-c89fba359fbf"
/>

dependencies.gradle

@@ -1,8 +1,8 @@
 // Add your dependencies here
 
 dependencies {
-    api("com.github.GTNewHorizons:GTNHLib:0.6.38:dev")
-    implementation("com.github.GTNewHorizons:NotEnoughItems:2.7.69-GTNH:dev")
+    api("com.github.GTNewHorizons:GTNHLib:0.7.1:dev")
+    implementation("com.github.GTNewHorizons:NotEnoughItems:2.8.21-GTNH:dev")
 
     testImplementation(platform('org.junit:junit-bom:5.9.2'))
     testImplementation('org.junit.jupiter:junit-jupiter')

gradle.properties

@@ -96,7 +96,9 @@ usesMixinDebug = false
 # Specify the location of your implementation of IMixinConfigPlugin. Leave it empty otherwise.
 mixinPlugin =
 
-# Specify the package that contains all of your Mixins. You may only place Mixins in this package or the build will fail!
+# Specify the package that contains all of your Mixins. The package must exist or
+# the build will fail. If you have a package property defined in your mixins.<modid>.json,
+# it must match with this or the build will fail.
 mixinsPackage = mixins
 
 # Specify the core mod entry class if you use a core mod. This class must implement IFMLLoadingPlugin!

settings.gradle

@@ -17,7 +17,7 @@ pluginManagement {
 }
 
 plugins {
-    id 'com.gtnewhorizons.gtnhsettingsconvention' version '1.0.41'
+    id 'com.gtnewhorizons.gtnhsettingsconvention' version '1.0.47'
 }
 
 

src/main/java/com/gtnewhorizon/structurelib/block/BlockHint.java

@@ -50,6 +50,10 @@ public class BlockHint extends Block {
 
     @Override
     public IIcon getIcon(int aSide, int aMeta) {
+        // For numbered hints, top and bottom are blank
+        if (aSide <= 1 && aMeta <= 11) {
+            return hint[13];
+        }
         return hint[aMeta];
     }
 

src/main/java/com/gtnewhorizon/structurelib/gui/GuiScreenConfigureChannels.java

@@ -164,40 +164,17 @@ public class GuiScreenConfigureChannels extends GuiContainer implements IGuiScre
         list.onGuiInit(this);
         autoCompleteList.onGuiInit(this);
 
-        addButton(
-                new GuiButton(
-                        ADD_BTN,
-                        guiLeft + 12,
-                        guiTop + 157,
-                        47,
-                        20,
-                        I18n.format("item.structurelib.constructableTrigger.gui.add")));
-        addButton(
-                new GuiButton(
-                        UNSET_BTN,
-                        guiLeft + 65,
-                        guiTop + 157,
-                        47,
-                        20,
-                        I18n.format("item.structurelib.constructableTrigger.gui.unset")));
-        addButton(
-                new GuiButton(
-                        WIPE_BTN,
-                        guiLeft + 118,
-                        guiTop + 157,
-                        47,
-                        20,
-                        I18n.format("item.structurelib.constructableTrigger.gui.wipe")));
+        addButton(new GuiButton(ADD_BTN, guiLeft + 12, guiTop + 157, 47, 20, I18n.format(I18N_PREFIX + "add")));
+        addButton(new GuiButton(UNSET_BTN, guiLeft + 65, guiTop + 157, 47, 20, I18n.format(I18N_PREFIX + "unset")));
+        addButton(new GuiButton(WIPE_BTN, guiLeft + 118, guiTop + 157, 47, 20, I18n.format(I18N_PREFIX + "wipe")));
 
         updateButtons();
         tooltipSplitCache.clear();
         info = StreamSupport
                 .stream(
-                        Splitter.on("\\n").split(
-                                StatCollector.translateToLocal("item.structurelib.constructableTrigger.gui.info"))
-                                .spliterator(),
+                        Splitter.on("\\n").split(StatCollector.translateToLocal(I18N_PREFIX + "info")).spliterator(),
                         false)
-                .flatMap(line -> fontRendererObj.listFormattedStringToWidth(line, width * 3 / 5).stream())
+                .flatMap(line -> fontRendererObj.listFormattedStringToWidth(line, width * 1 / 3).stream())
                 .collect(Collectors.toList());
     }
 
@@ -241,8 +218,7 @@ public class GuiScreenConfigureChannels extends GuiContainer implements IGuiScre
         actionPerformed(but);
     }
 
-    @SuppressWarnings("unchecked")
-    private List<GuiButton> getButtonList() {
+    public List<GuiButton> getButtonList() {
         return buttonList;
     }
 
@@ -322,11 +298,10 @@ public class GuiScreenConfigureChannels extends GuiContainer implements IGuiScre
                 }
                 break;
         }
-        if (key.textboxKeyTyped(aChar, aKey)) {
+        if (key.textboxKeyTyped(aChar, aKey) || value.textboxKeyTyped(aChar, aKey)) {
             updateButtons();
             return;
         }
-        if (value.textboxKeyTyped(aChar, aKey)) return;
         super.keyTyped(aChar, aKey);
     }
 
@@ -337,7 +312,8 @@ public class GuiScreenConfigureChannels extends GuiContainer implements IGuiScre
         boolean existing = !StringUtils.isEmpty(keyText) && ChannelDataAccessor.hasSubChannel(trigger, keyText);
         getButtonList().get(ADD_BTN).displayString = existing ? I18n.format(I18N_PREFIX + "set")
                 : I18n.format(I18N_PREFIX + "add");
-        getButtonList().get(ADD_BTN).enabled = !StringUtils.isBlank(value.getText())
+        getButtonList().get(ADD_BTN).enabled = !StringUtils.isBlank(key.getText())
+                && !StringUtils.isBlank(value.getText())
                 && Integer.parseInt(value.getText()) > 0;
         getButtonList().get(UNSET_BTN).enabled = existing && !StringUtils.isBlank(value.getText());
 
@@ -397,22 +373,10 @@ public class GuiScreenConfigureChannels extends GuiContainer implements IGuiScre
         int topLeftY = (this.height - this.getYSize()) / 2;
         drawTexturedModalRect(topLeftX, topLeftY, 0, 0, getXSize(), getYSize());
         list.drawScreen(mX, mY, partialTick);
-        fontRendererObj.drawString(
-                I18n.format("item.structurelib.constructableTrigger.gui.title"),
-                guiLeft + 12,
-                guiTop + 9,
-                0);
-        fontRendererObj.drawString(
-                I18n.format("item.structurelib.constructableTrigger.gui.key"),
-                guiLeft + 12,
-                guiTop + 122,
-                0);
+        fontRendererObj.drawString(I18n.format(I18N_PREFIX + "title"), guiLeft + 12, guiTop + 9, 0);
+        fontRendererObj.drawString(I18n.format(I18N_PREFIX + "key"), guiLeft + 12, guiTop + 122, 0);
         key.drawTextBox();
-        fontRendererObj.drawString(
-                I18n.format("item.structurelib.constructableTrigger.gui.value"),
-                guiLeft + 12,
-                guiTop + 142,
-                0);
+        fontRendererObj.drawString(I18n.format(I18N_PREFIX + "value"), guiLeft + 12, guiTop + 142, 0);
         value.drawTextBox();
     }
 
@@ -455,7 +419,7 @@ public class GuiScreenConfigureChannels extends GuiContainer implements IGuiScre
             tooltip.addAll(
                     fontRendererObj.listFormattedStringToWidth(
                             StatCollector.translateToLocalFormatted(
-                                    "item.structurelib.constructableTrigger.gui.channels.from",
+                                    I18N_PREFIX + "channels.from",
                                     Loader.instance().getIndexedModList().get(e.getKey()).getName()),
                             maxLine));
             tooltip.addAll(

src/main/java/com/gtnewhorizon/structurelib/item/ItemConstructableTrigger.java

@@ -28,11 +28,12 @@ public class ItemConstructableTrigger extends Item {
 
     @Override
     public ItemStack onItemRightClick(ItemStack stack, World world, EntityPlayer player) {
-        if (!world.isRemote && getMovingObjectPositionFromPlayer(world, player, true) == null) {
-            if (player.isSneaking()) {
-                StructureLib.instance().proxy().displayConfigGUI("registries");
-            } else {
+        if (getMovingObjectPositionFromPlayer(world, player, true) == null) {
+            // channel gui is opened from server and config gui from client
+            if (!world.isRemote && !player.isSneaking()) {
                 player.openGui(StructureLib.instance(), 0, world, player.inventory.currentItem, 0, 0);
+            } else if (world.isRemote && player.isSneaking()) {
+                StructureLib.instance().proxy().displayConfigGUI("registries");
             }
         }
         return super.onItemRightClick(stack, world, player);

src/main/java/com/gtnewhorizon/structurelib/structure/IStructureDefinition.java

@@ -319,6 +319,22 @@ public interface IStructureDefinition<T> {
         return walker.getBuilt();
     }
 
+    default void iterate(String piece, World world, ExtendedFacing extendedFacing, int basePositionX, int basePositionY,
+            int basePositionZ, int basePositionA, int basePositionB, int basePositionC, IStructureWalker<T> predicate) {
+        StructureUtility.iterateV2(
+                getStructureFor(piece),
+                world,
+                extendedFacing,
+                basePositionX,
+                basePositionY,
+                basePositionZ,
+                basePositionA,
+                basePositionB,
+                basePositionC,
+                predicate,
+                "customIterate");
+    }
+
     /**
      * Low level utility.
      *

src/main/java/com/gtnewhorizon/structurelib/structure/IStructureWalker.java

@@ -2,8 +2,25 @@ package com.gtnewhorizon.structurelib.structure;
 
 import net.minecraft.world.World;
 
-interface IStructureWalker<T> {
+/**
+ * A functional interface that is used to iterate over an arbitrary structure.
+ */
+@FunctionalInterface
+public interface IStructureWalker<T> {
 
+    /**
+     * Called once per structure element.
+     *
+     * @param element The current element
+     * @param world   The current world
+     * @param x       The absolute X position of the element in world coordinates
+     * @param y       The absolute Y position of the element in world coordinates
+     * @param z       The absolute Z position of the element in world coordinates
+     * @param a       The relative A position of the element in structure-local coordinates (pre transform)
+     * @param b       The relative B position of the element in structure-local coordinates (pre transform)
+     * @param c       The relative C position of the element in structure-local coordinates (pre transform)
+     * @return False to stop iterating, true to continue.
+     */
     boolean visit(IStructureElement<T> element, World world, int x, int y, int z, int a, int b, int c);
 
     default boolean blockNotLoaded(IStructureElement<T> element, World world, int x, int y, int z, int a, int b,

src/main/resources/assets/structurelib/lang/en_US.lang

@@ -34,11 +34,11 @@ item.structurelib.constructableTrigger.gui.title=Sub Channels
 item.structurelib.constructableTrigger.gui.key=Key:
 item.structurelib.constructableTrigger.gui.value=Value:
 item.structurelib.constructableTrigger.gui.add=Add
-item.structurelib.constructableTrigger.gui.set=Set
-item.structurelib.constructableTrigger.gui.unset=Unset
-item.structurelib.constructableTrigger.gui.wipe=§4Wipe
+item.structurelib.constructableTrigger.gui.set=Update
+item.structurelib.constructableTrigger.gui.unset=Remove
+item.structurelib.constructableTrigger.gui.wipe=§4Clear
 item.structurelib.constructableTrigger.gui.channels.from=§rMod: §9§o%s
-item.structurelib.constructableTrigger.gui.info=Many multiblocks support some degree of variation in its structure and use sub channels to indicate which variant to use.\n Sub channels are has a sequence of lower case characters as key and a positive integer as value. Most known sub channels should be available as typeahead completions.\nYou can also drag and drop items from NEI to set the corresponding sub channel value. These items all have a tooltip of §oIndicates value X for sub channel Y§r.
+item.structurelib.constructableTrigger.gui.info=Many multiblocks support some degree of variation in their structure and a sub channel allows indication of which variant to use.\n All sub channels have a sequence of lowercase characters as key and a positive integer as value. Most known sub channels should be available as typeahead completions.\n You can also drag and drop items from NEI to set the corresponding sub channel value. These items all have a tooltip of "§oIndicates§r §ovalue§r §oX§r §ofor§r §osub§r §ochannel§r §oY§r".
 
 channels.structurelib.show_errors=When set, will highlight parts of the multiblock that is definitely wrong