Deprecate itemGroups field

Since 1.19.3, this was only populated when the player opened the
creative menu, and so was useless in survival or multi-player
worlds.

Rather than removing the field entirely (🦑 backwards compatibility), we
replace it with the empty list. We also remove it from the docs, and add
a note explaining what the field used to do.

Closes #1285, albeit in the least satisfactory way possible.

projects/common/src/main/java/dan200/computercraft/shared/details/ItemDetails.java

@@ -5,14 +5,11 @@
 package dan200.computercraft.shared.details;
 
 import com.google.gson.JsonParseException;
-import dan200.computercraft.shared.platform.PlatformHelper;
 import dan200.computercraft.shared.platform.RegistryWrappers;
 import dan200.computercraft.shared.util.NBTUtil;
 import net.minecraft.nbt.ListTag;
 import net.minecraft.nbt.Tag;
 import net.minecraft.network.chat.Component;
-import net.minecraft.world.item.CreativeModeTab;
-import net.minecraft.world.item.CreativeModeTabs;
 import net.minecraft.world.item.EnchantedBookItem;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.enchantment.EnchantmentHelper;
@@ -45,7 +42,9 @@ public static void fill(Map<? super String, Object> data, ItemStack stack) {
         }
 
         data.put("tags", DetailHelpers.getTags(stack.getTags()));
-        data.put("itemGroups", getItemGroups(stack));
+
+        // Include deprecated itemGroups field
+        data.put("itemGroups", List.of());
 
         var tag = stack.getTag();
         if (tag != null && tag.contains("display", Tag.TAG_COMPOUND)) {
@@ -84,27 +83,6 @@ private static Component parseTextComponent(Tag x) {
         }
     }
 
-    /**
-     * Retrieve all item groups an item stack pertains to.
-     *
-     * @param stack Stack to analyse
-     * @return A filled list that contains pairs of item group IDs and their display names.
-     */
-    private static List<Map<String, Object>> getItemGroups(ItemStack stack) {
-        return CreativeModeTabs.allTabs().stream()
-            .filter(x -> x.shouldDisplay() && x.getType() == CreativeModeTab.Type.CATEGORY && x.contains(stack))
-            .map(group -> {
-                Map<String, Object> groupData = new HashMap<>(2);
-
-                var id = PlatformHelper.get().getCreativeTabId(group);
-                if (id != null) groupData.put("id", id.toString());
-
-                groupData.put("displayName", group.getDisplayName().getString());
-                return groupData;
-            })
-            .toList();
-    }
-
     /**
      * Retrieve all visible enchantments from given stack. Try to follow all tooltip rules : order and visibility.
      *

projects/common/src/main/java/dan200/computercraft/shared/platform/PlatformHelper.java

@@ -33,7 +33,6 @@
 import net.minecraft.world.inventory.AbstractContainerMenu;
 import net.minecraft.world.inventory.CraftingContainer;
 import net.minecraft.world.inventory.MenuType;
-import net.minecraft.world.item.CreativeModeTab;
 import net.minecraft.world.item.DyeColor;
 import net.minecraft.world.item.Item;
 import net.minecraft.world.item.ItemStack;
@@ -273,15 +272,6 @@ static PlatformHelper get() {
      */
     int getBurnTime(ItemStack stack);
 
-    /**
-     * Get a unique identifier for this creative tab.
-     *
-     * @param tab The tab to get
-     * @return The unique identifier, or {@code null} if not available.
-     */
-    @Nullable
-    ResourceLocation getCreativeTabId(CreativeModeTab tab);
-
     /**
      * Get the "container" item to be returned after crafting. For instance, crafting with a lava bucket should return
      * an empty bucket.

projects/common/src/test/java/dan200/computercraft/TestPlatformHelper.java

@@ -36,7 +36,6 @@
 import net.minecraft.world.inventory.AbstractContainerMenu;
 import net.minecraft.world.inventory.CraftingContainer;
 import net.minecraft.world.inventory.MenuType;
-import net.minecraft.world.item.CreativeModeTab;
 import net.minecraft.world.item.Item;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.crafting.Recipe;
@@ -165,13 +164,6 @@ public boolean onNotifyNeighbour(Level level, BlockPos pos, BlockState block, Di
         throw new UnsupportedOperationException("Cannot interact with the world inside tests");
     }
 
-
-    @Nullable
-    @Override
-    public ResourceLocation getCreativeTabId(CreativeModeTab tab) {
-        return null;
-    }
-
     @Override
     public RecipeIngredients getRecipeIngredients() {
         throw new UnsupportedOperationException("Cannot query recipes inside tests");

projects/fabric/src/main/java/dan200/computercraft/shared/platform/PlatformHelperImpl.java

@@ -256,12 +256,6 @@ public int getBurnTime(ItemStack stack) {
         return fuel == null ? 0 : fuel;
     }
 
-    @Nullable
-    @Override
-    public ResourceLocation getCreativeTabId(CreativeModeTab tab) {
-        return tab.getId();
-    }
-
     @Override
     public ItemStack getCraftingRemainingItem(ItemStack stack) {
         return stack.getRecipeRemainder();

projects/forge/src/main/java/dan200/computercraft/shared/peripheral/generic/methods/InventoryMethods.java

@@ -96,13 +96,18 @@ public static int size(IItemHandler inventory) {
      * <p>
      * The returned information contains the same information as each item in
      * {@link #list}, as well as additional details like the display name
-     * (`displayName`), item groups (`itemGroups`), which are the creative tabs
-     * an item will appear under, and item and item durability (`damage`,
-     * `maxDamage`, `durability`).
+     * (`displayName`), and item and item durability (`damage`, `maxDamage`, `durability`).
      * <p>
      * Some items include more information (such as enchantments) - it is
      * recommended to print it out using @{textutils.serialize} or in the Lua
      * REPL, to explore what is available.
+     * <p>
+     * :::info Deprecated fields
+     * Older versions of CC: Tweaked exposed an {@code itemGroups} field, listing the
+     * creative tabs an item was available under. This information is no longer available on
+     * more recent versions of the game, and so this field will always be empty. Do not use this
+     * field in new code!
+     * :::
      *
      * @param inventory The current inventory.
      * @param slot      The slot to get information about.
@@ -119,10 +124,6 @@ public static int size(IItemHandler inventory) {
      * print(("%s (%s)"):format(item.displayName, item.name))
      * print(("Count: %d/%d"):format(item.count, item.maxCount))
      *
-     * for _, group in pairs(item.itemGroups) do
-     *   print(("Group: %s"):format(group.displayName))
-     * end
-     *
      * if item.damage then
      *   print(("Damage: %d/%d"):format(item.damage, item.maxDamage))
      * end

projects/forge/src/main/java/dan200/computercraft/shared/platform/PlatformHelperImpl.java

@@ -38,7 +38,6 @@
 import net.minecraft.world.inventory.AbstractContainerMenu;
 import net.minecraft.world.inventory.CraftingContainer;
 import net.minecraft.world.inventory.MenuType;
-import net.minecraft.world.item.CreativeModeTab;
 import net.minecraft.world.item.Item;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.context.UseOnContext;
@@ -52,7 +51,6 @@
 import net.minecraft.world.level.chunk.LevelChunk;
 import net.minecraft.world.phys.BlockHitResult;
 import net.minecraft.world.phys.Vec3;
-import net.minecraftforge.common.CreativeModeTabRegistry;
 import net.minecraftforge.common.ForgeHooks;
 import net.minecraftforge.common.Tags;
 import net.minecraftforge.common.ToolActions;
@@ -258,12 +256,6 @@ public int getBurnTime(ItemStack stack) {
         return ForgeHooks.getBurnTime(stack, null);
     }
 
-    @Nullable
-    @Override
-    public ResourceLocation getCreativeTabId(CreativeModeTab tab) {
-        return CreativeModeTabRegistry.getName(tab);
-    }
-
     @Override
     public ItemStack getCraftingRemainingItem(ItemStack stack) {
         return stack.getCraftingRemainingItem();