Tag manager (#771) (#772)

Author: Raycoms

src/main/java/com/ldtteam/structurize/client/gui/WindowTagTool.java

@@ -7,10 +7,12 @@
 import com.ldtteam.structurize.Network;
 import com.ldtteam.structurize.api.util.constant.Constants;
 import com.ldtteam.structurize.blockentities.interfaces.IBlueprintDataProviderBE;
+import com.ldtteam.structurize.blocks.interfaces.IAnchorBlock;
 import com.ldtteam.structurize.items.ItemTagTool;
 import com.ldtteam.structurize.network.messages.AddRemoveTagMessage;
 import com.ldtteam.structurize.network.messages.SetTagInTool;
 import com.ldtteam.structurize.util.BlockUtils;
+import com.ldtteam.structurize.util.TagManager;
 import net.minecraft.client.Minecraft;
 import net.minecraft.network.chat.Component;
 import net.minecraft.world.item.ItemStack;
@@ -20,20 +22,8 @@
 
 import java.util.*;
 
-import static com.ldtteam.structurize.api.util.constant.Constants.GROUNDLEVEL_TAG;
-
 public class WindowTagTool extends AbstractWindowSkeleton
 {
-    /**
-     * List of tag options. Mods can just insert on this in mod constructor.
-     */
-    public static List<String> TAG_OPTIONS = new ArrayList<>();
-
-    static
-    {
-        TAG_OPTIONS.add(GROUNDLEVEL_TAG);
-    }
-
     private static final String WINDOW_TAG_TOOL    = ":gui/windowtagtool.xml";
     private static final String INPUT_FIELD        = "currentTag";
     private static final String LIST_TAG_POS       = "tagposlist";
@@ -75,12 +65,16 @@ public class WindowTagTool extends AbstractWindowSkeleton
      */
     private List<BlockPos> positionsList = Collections.emptyList();
 
-
     /**
      * The tags list
      */
     private ScrollingList tagOptionList;
 
+    /**
+     * Tag options.
+     */
+    private List<String> tagOptions = new ArrayList<>();
+
     /**
      * Constructor for the skeleton class of the windows.
      */
@@ -92,13 +86,23 @@ public WindowTagTool(String currentTag, BlockPos anchorPos, final Level world, f
         this.anchorPos = anchorPos;
         this.stack = stack;
 
+        tagOptions.addAll(TagManager.getGlobalTagOptions());
+
+        if (anchorPos != null)
+        {
+            final BlockEntity blockEntity = world.getBlockEntity(anchorPos);
+            if (blockEntity instanceof IAnchorBlock anchorBlock)
+            {
+                tagOptions.addAll(TagManager.getMatchingTagOptions(anchorBlock));
+            }
+        }
         registerButton(TAG_SELECT, this::tagOptionSelected);
     }
 
     private void tagOptionSelected(final Button button)
     {
         final int row = tagOptionList.getListElementIndexByPane(button);
-        this.currentTag = TAG_OPTIONS.get(row);
+        this.currentTag = tagOptions.get(row);
         findPaneOfTypeByID(INPUT_FIELD, TextField.class).setText(currentTag);
     }
 
@@ -238,19 +242,19 @@ public void updateTagOptionList()
             @Override
             public int getElementCount()
             {
-                return TAG_OPTIONS.size();
+                return tagOptions.size();
             }
 
             @Override
             public void updateElement(final int index, final Pane rowPane)
             {
                 final Text tagsText = rowPane.findPaneOfTypeByID(TAG_TEXT, Text.class);
-                tagsText.setText(Component.literal(TAG_OPTIONS.get(index)));
+                tagsText.setText(Component.literal(tagOptions.get(index)));
                 PaneBuilders.tooltipBuilder().hoverPane(tagsText).build()
-                    .setText(Component.translatable("com.ldtteam.tag.tooltip." + TAG_OPTIONS.get(index)));
+                    .setText(Component.translatable("com.ldtteam.tag.tooltip." + tagOptions.get(index)));
 
                 final Button button = rowPane.findPaneOfTypeByID(TAG_SELECT, Button.class);
-                button.setEnabled(!TAG_OPTIONS.get(index).equals(currentTag));
+                button.setEnabled(!tagOptions.get(index).equals(currentTag));
             }
         });
     }

src/main/java/com/ldtteam/structurize/util/TagManager.java

@@ -0,0 +1,77 @@
+package com.ldtteam.structurize.util;
+
+import com.ldtteam.structurize.blocks.interfaces.IAnchorBlock;
+
+import java.util.*;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
+
+import static com.ldtteam.structurize.api.util.constant.Constants.GROUNDLEVEL_TAG;
+import static com.ldtteam.structurize.api.util.constant.Constants.INVISIBLE_TAG;
+
+/**
+ * Handles tags.
+ */
+public class TagManager
+{
+    /**
+     * List of tag options. Mods can just insert on this in mod constructor.
+     */
+    private static Set<String> GLOBAL_TAG_OPTIONS = new HashSet<>();
+
+    /**
+     * Block specific tag options.
+     */
+    private static Map<String, Predicate<IAnchorBlock>> BLOCK_SPECIFIC_TAG_OPTIONS = new HashMap<>();
+
+    static
+    {
+        GLOBAL_TAG_OPTIONS.add(GROUNDLEVEL_TAG);
+        GLOBAL_TAG_OPTIONS.add(INVISIBLE_TAG);
+    }
+    /**
+     * Register a new global tag option.
+     * @param tag the option to register.
+     */
+    public static void registerGlobalTagOption(final String tag)
+    {
+        GLOBAL_TAG_OPTIONS.add(tag);
+    }
+
+    /**
+     * Register a block specific tag option.
+     * @param tag the tag to register.
+     * @param predicate the predicate that has to apply.
+     */
+    public static void registerSpecificTagOption(final String tag, final Predicate<IAnchorBlock> predicate)
+    {
+        final Predicate<IAnchorBlock> storedPredicate = BLOCK_SPECIFIC_TAG_OPTIONS.getOrDefault(tag, null);
+        if (storedPredicate == null)
+        {
+            BLOCK_SPECIFIC_TAG_OPTIONS.put(tag, predicate);
+        }
+        else
+        {
+            BLOCK_SPECIFIC_TAG_OPTIONS.put(tag, storedPredicate.or(predicate));
+        }
+    }
+
+    /**
+     * Get all matching tag options for a block.
+     * @param block the block to match.
+     * @return collection of options.
+     */
+    public static Collection<String> getMatchingTagOptions(final IAnchorBlock block)
+    {
+        return BLOCK_SPECIFIC_TAG_OPTIONS.entrySet().stream().filter(entry -> entry.getValue().test(block)).map(Map.Entry::getKey).collect(Collectors.toSet());
+    }
+
+    /**
+     * Get all global tag options.
+     * @return the collection of global tag options.
+     */
+    public static Collection<String> getGlobalTagOptions()
+    {
+        return GLOBAL_TAG_OPTIONS;
+    }
+}

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

@@ -219,7 +219,8 @@
   "structurize.gui.content.entities": "Entities",
   "structurize.gui.content.entities_content": "Entity contents",
   "com.ldtteam.structurize.gui.taglist.title": "Existing tags in schematic:",
-  "com.ldtteam.structurize.gui.tagoptions.title": "Tag Suggestions:",
-  "com.ldtteam.tag.tooltip.groundlevel": "Used by the Buildtool to position the blueprint on the floor"
+  "com.ldtteam.structurize.gui.tagoptions.title": "Registered Tags:",
+  "com.ldtteam.tag.tooltip.groundlevel": "Used by the Buildtool to position the blueprint on the floor",
+  "com.ldtteam.tag.tooltip.invisible": "Hide Blueprint in Buildtool like Integrated Buildings or Mineshafts"
 
 }