add tool types (#73)

* add tool types

* Apply suggestions from code review

Co-authored-by: Glitch <[email protected]>

* Move ToolType class to its own subproject

Use HashMap constructor instead of Maps method

* FIXUP!

Co-authored-by: Glitch <[email protected]>
Co-authored-by: Kitlith <[email protected]>

Author: 3 people

patchwork-extensions-item/build.gradle

@@ -1,2 +1,6 @@
 archivesBaseName = "patchwork-extensions-item"
 version = getSubprojectVersion(project, "0.1.0")
+
+dependencies {
+  compile project(path: ':patchwork-tooltype', configuration: 'dev')
+}

patchwork-extensions-item/src/main/java/net/minecraftforge/common/extensions/IForgeItem.java

@@ -30,6 +30,7 @@
 
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Multimap;
+import net.minecraftforge.common.ToolType;
 
 import net.minecraft.block.BlockState;
 import net.minecraft.client.font.TextRenderer;
@@ -563,7 +564,7 @@ default int getItemStackLimit(ItemStack stack) {
 	}
 
 	// TODO: Call locations: Patches: MiningToolItem, Forge classes: IForgeItemStack, ForgeHooks*
-	Set<Object /* TODO: ToolType */> getToolTypes(ItemStack stack);
+	Set<ToolType> getToolTypes(ItemStack stack);
 
 	// TODO: Call locations: Forge classes: IForgeItemStack, ForgeHooks
 	/**
@@ -576,7 +577,7 @@ default int getItemStackLimit(ItemStack stack) {
 	 * @param blockState The block to harvest
 	 * @return Harvest level, or -1 if not the specified tool type.
 	 */
-	int getHarvestLevel(ItemStack stack, Object /* TODO: ToolType */ tool, @Nullable PlayerEntity player, @Nullable BlockState blockState);
+	int getHarvestLevel(ItemStack stack, ToolType tool, @Nullable PlayerEntity player, @Nullable BlockState blockState);
 
 	// TODO: Call locations: Patches: EnchantmentHelper, Forge classes: IForgeItemStack
 	/**

patchwork-extensions-item/src/main/java/net/patchworkmc/impl/extensions/item/PatchworkItemSettingsExtensions.java

@@ -23,6 +23,8 @@
 import java.util.concurrent.Callable;
 import java.util.function.Supplier;
 
+import net.minecraftforge.common.ToolType;
+
 import net.minecraft.client.render.item.BuiltinModelItemRenderer;
 import net.minecraft.item.Item;
 
@@ -36,13 +38,13 @@
 public interface PatchworkItemSettingsExtensions {
 	Item.Settings setNoRepair();
 
-	Item.Settings addToolType(Object /* TODO: ToolType */ type, int level);
+	Item.Settings addToolType(ToolType type, int level);
 
 	Item.Settings setTEISR(Supplier<Callable<BuiltinModelItemRenderer>> teisr);
 
 	boolean canRepair();
 
-	Map<Object /* TODO: ToolType */, Integer> getToolClasses();
+	Map<ToolType, Integer> getToolClasses();
 
 	@Environment(EnvType.CLIENT)
 	BuiltinModelItemRenderer getTeisr();

patchwork-extensions-item/src/main/java/net/patchworkmc/mixin/extensions/item/MixinItem.java

@@ -26,6 +26,7 @@
 import javax.annotation.Nullable;
 
 import com.google.common.collect.Maps;
+import net.minecraftforge.common.ToolType;
 import net.minecraftforge.common.extensions.IForgeItem;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.Shadow;
@@ -50,7 +51,7 @@
 
 @Mixin(Item.class)
 public abstract class MixinItem implements IForgeItem {
-	@Unique private Map<Object /* TODO: ToolType */, Integer> toolClasses;
+	@Unique private Map<ToolType, Integer> toolClasses;
 	protected boolean canRepair;
 
 	@Inject(at = @At("RETURN"), method = "<init>")
@@ -81,12 +82,12 @@ public boolean isRepairable(ItemStack stack) {
 	}
 
 	@Override
-	public Set<Object /* TODO: ToolType */> getToolTypes(ItemStack stack) {
+	public Set<ToolType> getToolTypes(ItemStack stack) {
 		return toolClasses.keySet();
 	}
 
 	@Override
-	public int getHarvestLevel(ItemStack stack, Object /* TODO: ToolType */ tool, @Nullable PlayerEntity player, @Nullable BlockState blockState) {
+	public int getHarvestLevel(ItemStack stack, ToolType tool, @Nullable PlayerEntity player, @Nullable BlockState blockState) {
 		return toolClasses.getOrDefault(tool, -1);
 	}
 

patchwork-extensions-item/src/main/java/net/patchworkmc/mixin/extensions/item/MixinItemSettings.java

@@ -22,6 +22,7 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import net.minecraftforge.common.ToolType;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.Unique;
 
@@ -33,7 +34,7 @@
 @Mixin(Item.Settings.class)
 public abstract class MixinItemSettings implements PatchworkItemSettingsExtensions {
 	@Unique private boolean canRepair = true;
-	@Unique private final Map<Object /* TODO: ToolType */, Integer> toolClasses = new HashMap<>();
+	@Unique private final Map<ToolType, Integer> toolClasses = new HashMap<>();
 
 	@Override
 	public Settings setNoRepair() {
@@ -42,7 +43,7 @@ public Settings setNoRepair() {
 	}
 
 	@Override
-	public Settings addToolType(Object /* TODO: ToolType */ type, int level) {
+	public Settings addToolType(ToolType type, int level) {
 		toolClasses.put(type, level);
 		return (Settings) (Object) this;
 	}
@@ -53,7 +54,7 @@ public boolean canRepair() {
 	}
 
 	@Override
-	public Map<Object /* TODO: ToolType */, Integer> getToolClasses() {
+	public Map<ToolType, Integer> getToolClasses() {
 		return toolClasses;
 	}
 }

patchwork-extensions-item/src/main/resources/fabric.mod.json

@@ -16,7 +16,8 @@
   ],
   "depends": {
     "fabricloader": ">=0.8.4",
-    "fabric": "*"
+    "fabric": "*",
+    "patchwork-tooltype": "*"
   },
   "mixins": [
     "patchwork-extensions-item.mixins.json"

patchwork-tooltype/build.gradle

@@ -0,0 +1,3 @@
+archivesBaseName = "patchwork-tooltype"
+version = getSubprojectVersion(project, "0.1.0")
+

patchwork-tooltype/src/main/java/net/minecraftforge/common/ToolType.java

@@ -0,0 +1,50 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.minecraftforge.common;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.regex.Pattern;
+
+public final class ToolType {
+	private static final Pattern VALID_NAME = Pattern.compile("[^a-z_]"); //Only a-z and _ are allowed, meaning names must be lower case and use _ to separate words.
+	private static final Map<String, ToolType> values = new HashMap<>();
+
+	public static final ToolType AXE = get("axe");
+	public static final ToolType PICKAXE = get("pickaxe");
+	public static final ToolType SHOVEL = get("shovel");
+	private final String name;
+
+	private ToolType(String name) {
+		this.name = name;
+	}
+
+	public static ToolType get(String name) {
+		if (VALID_NAME.matcher(name).find()) {
+			throw new IllegalArgumentException("ToolType.get() called with invalid name: " + name);
+		}
+
+		return values.computeIfAbsent(name, k -> new ToolType(name));
+	}
+
+	public String getName() {
+		return name;
+	}
+}

patchwork-tooltype/src/main/resources/assets/patchwork-tooltype/icon.png

@@ -0,0 +1,25 @@
+{
+  "schemaVersion": 1,
+  "id": "patchwork-tooltype",
+  "name": "Patchwork ToolType",
+  "version": "${version}",
+  "description": "Includes the Minecraft Forge ToolType class",
+  "environment": "*",
+  "license": "LGPL-2.1-only",
+  "icon": "assets/patchwork-tooltype/icon.png",
+  "contact": {
+    "issues": "https://github.com/PatchworkMC/patchwork-api/issues",
+    "sources": "https://github.com/PatchworkMC/patchwork-api"
+  },
+  "authors": [
+    "PatchworkMC"
+  ],
+  "depends": {
+    "fabricloader": ">=0.8.4",
+    "fabric": "*"
+  },
+  "custom": {
+    "modmenu:api": true,
+    "modmenu:parent": "patchwork"
+  }
+}