Fabric Wiki

User Tools

Site Tools

Trace:
tutorial:tools

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
tutorial:tools [2020/07/30 11:03] – Fixed an incorrect method name boogiemonster1o1tutorial:tools [2024/08/23 13:25] (current) – [Adding Tools] solidblock
Line 1: Line 1:
 ====== Adding Tools ====== ====== Adding Tools ======
 +:!: This tutorial may be **outdated** as since 1.20.5, item components are used. For latest tutorial see [[https://docs.fabricmc.net/develop/items/custom-tools|corresponding page on Fabric Docs]].
  
-==== Introduction ==== +===== Creating a Tool Material =====
-Creating a tool is very similar to making armor. It's a bit more complicated than making an item, but it's easy to make multiple of them+
  
-==== Creating a Tool Material class ====+Tools require a ''<yarn class_1832>'', which defines the following behavior: 
 +  * durability 
 +  * mining speed 
 +  * attack damage 
 +  * mining level 
 +  * enchantability 
 +  * repair ingredient
  
-The first step to creating a tool is to implement the `ToolMaterial` interface in a class+In other words, Tool Materials defines the //base// functionality for tools of that type, and tools can choose to use the values provided by the material, or roll with their own.
  
-It's best to make the class as an enum, as it doesnt require you to create an object a regular class, and enum constants make adding tool materials easier.+Vanilla Tool Materials can be found in ''<yarn class_1834>''. We will create a separate class for our material:
  
- +<yarncode java [enable_line_numbers=true]> 
-<code java [enable_line_numbers=true]> +public class PotatoToolMaterial implements class_1832 { 
-public enum CustomToolMaterial implements ToolMaterial {; +    [...]
-    CustomToolMaterial(int miningLevel, int itemDurability, float miningSpeedMultiplier, float attackDamage, int enchantability, Supplier<Ingredient> repairIngredient) { +
-  +
-    }+
 } }
-</code>+</yarncode>
  
-What each argument does:- +''<yarn class_1832>'' has a number of methods you will need to implement:
-1. `miningLevel` refers to the strength of the tool necessary to mine any material. Wood is 1, Stone is 2, Iron is 3, Diamond is 4. +
-2. `itemDurability` refers to the initial durability of a tool. Gold is 32, Iron is 250, Netherite is 2031. +
-3. `miningSpeedMultiplier ` refers to how fast your tools can break blocks. Gold is 12.0f, Diamond is 8.0f, Iron is 6.0f. +
-4. `attackDamage` refers to the melee damage that your tools perform. Wood is 0.0f, Stone is 1.0f, Diamond is 3.0f +
-5. `enchantability` refers to the chance of getting high-level enchantments on your tools. Wood is 15, Stone is 5, Gold is 22, Iron is 14. +
-6. `repairIngredient` refers to the item that can repair your tools in an anvil. This will not be stored in an `Ingredient`, but in a `Lazy<Ingredient>`, which requires a `Supplier` in the constructor. +
- +
-To make these values accessible from outside the constructor, create a final field for each of them and assign their values in the constructor. +
-<code java [enable_line_numbers=true]> +
-public enum CustomToolMaterial implements ToolMaterial {; +
-    private final int miningLevel; +
-    private final int itemDurability; +
-    private final float miningSpeedMultiplier; +
-    private final float attackDamage; +
-    private final int enchantability; +
-    private final Lazy<Ingredient> repairIngredient; +
- +
-    CustomToolMaterial(int miningLevel, int itemDurability, float miningSpeedMultiplier, float attackDamage, int enchantability, Supplier<Ingredient> repairIngredient) { +
-        this.miningLevel = miningLevel; +
-        this.itemDurability = itemDurability; +
-        this. miningSpeedMultiplier = miningSpeedMultiplier; +
-        this.attackDamage = attackDamage; +
-        this.enchantability = enchantability; +
-        this.repairIngredient = new Lazy<>(repairIngredient); +
-    } +
-} +
-</code> +
- +
-Now its time to implement the methods from the `ToolMaterial` interface.  +
-You should have something like this. Change the return value of each implemented method to the corresponding field. +
-<code java [enable_line_numbers=true]> +
-public enum CustomToolMaterial implements ToolMaterial {; +
-    private final int miningLevel; +
-    private final int itemDurability; +
-    private final float miningSpeedMultiplier; +
-    private final float attackDamage; +
-    private final int enchantability; +
-    private final Lazy<Ingredient> repairIngredient; +
- +
-    CustomToolMaterial(int miningLevel, int itemDurability, float miningSpeedMultiplier, float attackDamage, int enchantability, Supplier<Ingredient> repairIngredient) { +
-        this.miningLevel = miningLevel; +
-        this.itemDurability = itemDurability; +
-        this.miningSpeedMultiplier = miningSpeedMultiplier; +
-        this.attackDamage = attackDamage; +
-        this.enchantability = enchantability; +
-        this.repairIngredient = new Lazy<>(repairIngredient); +
-    }+
  
 +=== Durability === 
 +''<yarn method_8025>'' defines the base durability tools will have when they use this material. In vanilla, all tools of the same type have the same durability.
 +<yarncode java [enable_line_numbers=true]>
     @Override     @Override
-    public int getDurability() { +    public int method_8025() { 
-        return this.itemDurability;+        return 500;
     }     }
 +</yarncode>
  
 +=== Mining Speed === 
 +''<yarn method_8027>'' defines how fast tools are when mining blocks. For a general sense of scale, Wooden has a speed of 2.0F, and Diamond has a speed of 8.0F.
 +<yarncode java [enable_line_numbers=true]>
     @Override     @Override
-    public float getMiningSpeedMultiplier() { +    public float method_8027() { 
-        return this.miningSpeedMultiplier;+        return 5.0F;
     }     }
 +</yarncode>
  
 +=== Attack Damage === 
 +''<yarn method_8028>'' returns the base damage of the tool. Note that //most// tools ask for an integer damage amount in their constructor, which means the resulting damage is ''(float) materialDamage + (int) toolDamage + 1''. If you want your tool to entirely control its damage amount in its constructor, you can make your material return an attack damage of 0F. 
 +<yarncode java [enable_line_numbers=true]>
     @Override     @Override
-    public float getAttackDamage() { +    public float method_8028() { 
-        return this.attackDamage;+        return 3.0F;
     }     }
 +</yarncode>
  
 +=== Mining Level === 
 +''<yarn method_8024>'' sets the mining level of a tool. Diamond has a mining level of 3, and a value of 3+ is required to mine Obsidian.
 +<yarncode java [enable_line_numbers=true]>
     @Override     @Override
-    public int getMiningLevel() { +    public int method_8024() { 
-        return this.miningLevel;+        return 2;
     }     }
 +</yarncode>
  
 +=== Enchantability === 
 +''<yarn method_8026>'' defines how enchantable a tool is. Gold comes in at 22 Enchatability, while Diamond sits at 10. Higher enchantability means better (and higher-level) enchantments.
 +<yarncode java [enable_line_numbers=true]>
     @Override     @Override
-    public int getEnchantability() { +    public int method_8026() { 
-        return this.enchantability;+        return 15;
     }     }
 +</yarncode>
  
 +=== Repair Ingredient === 
 +''<yarn method_8023>'' returns the ''<yarn class_1856>'' required to repair a tool in an anvil.
 +<yarncode java [enable_line_numbers=true]>
     @Override     @Override
-    public Ingredient getRepairIngredient() { +    public class_1856 method_8023() { 
-        return this.repairIngredient.get();+        return class_1856.method_8091(class_1802.field_8567);
     }     }
-} +</yarncode>
-</code> +
- +
-Next, create an enum constant. You can create multiple enum constants if you need multiple tool materials.  +
-This enum constant is for potato tools.+
  
-<code java [enable_line_numbers=true]> +''<yarn class_1832>''s do //not// have to be registered. A good way to pass them out to tools that require them is by keeping an instance somewhere (and then referencing it when you need it). In this case, we will put our instance at the top of the class: 
-public enum CustomToolMaterial implements ToolMaterial { +<yarncode java [enable_line_numbers=true]> 
-    POTATO(1, 167, 4.8F, 1.1F, 11, () -> { +public class PotatoToolMaterial implements class_1832 { 
-        return Ingredient.ofItems(Items.POTATO); +    public static final PotatoToolMaterial INSTANCE = new PotatoToolMaterial();
-    });+
          
     [...]     [...]
 } }
-</code>+</yarncode>
  
 +''PotatoToolMaterial'' can now be referenced with ''PotatoToolMaterial.INSTANCE''. Alternatively, you can implement an enum similar to vanilla's ''ToolMaterials'' class that implements ''ToolMaterial'', which provides the instance and also allows easy creation of multiple tool materials.
  
-==== Creating the tool objects ====+===== Creating Tools Items =====
  
-Swords, shovels, pickaxes and axes take in four arguments : The Tool Material, The Attack Damage, The Attack Speed and Item Settings+**In newer versions, all base tool class constructors are public and can be used directly to register the item.** This constructor lets you specify attack damage and attack speed of the tool. Remember they should be registered (see [[items]] tutorial).
  
-<code java [enable_line_numbers=true]> +<yarncode java> 
-public static ToolItem POTATO_SHOVEL = new ShovelItem(CustomToolMaterial.POTATO, 1.5F, -3.0F, new Item.Settings().group(ItemGroup.TOOLS)); +public final class TutorialItems { 
-public static ToolItem POTATO_SWORD = new SwordItem(CustomToolMaterial.POTATO, 3, -2.4F, new Item.Settings().group(ItemGroup.COMBAT)); +    public static class_1831 POTATO_PICKAXE = new PickaxeItem(PotatoToolMaterial.INSTANCE, 1, -2.8F, new FabricItemSettings()); 
-</code> +    public static class_1831 POTATO_AXE = new AxeItem(PotatoToolMaterial.INSTANCE, 7.0F, -3.2F, new FabricItemSettings()); 
-Unfortunately, `PickaxeItem` , `HoeItem` and `AxeItem` only have protected constructors, so you'll have to make classes that extends each of them. Creating a subclass makes making multiple pickaxes or axes easier. +    public static class_1831 POTATO_HOE = new HoeItem(PotatoToolMaterial.INSTANCE, 7, -3.2F, new FabricItemSettings());
-<code java [enable_line_numbers=true]> +
-public class PickaxeSubclass extends PickaxeItem { +
-    public PickaxeSubclass(ToolMaterial material, int attackDamage, float attackSpeed, Settings settings) { +
-        super(material, attackDamage, attackSpeed, settings); +
-    }+
 } }
-</code> +</yarncode>
-To make a pickaxe, hoe and axe, create objects of the subclasses. +
-<code java> +
-public static ToolItem POTATO_PICKAXE = new PickaxeSubclass(CustomToolMaterial.POTATO, 1, -2.8F, new Item.Settings().group(ItemGroup.TOOLS)); +
-public static ToolItem POTATO_AXE = new AxeSubclass(CustomToolMaterial.POTATO, 7.0F, -3.2F, new Item.Settings().group(ItemGroup.TOOLS)); +
-public static ToolItem POTATO_HOE = new HoeSubclass(CustomToolMaterial.POTATO, 7, -3.2F, new Item.Settings().group(ItemGroup.TOOLS)); +
-</code>+
  
-If you want to add any special attributes or behavior to your tool, create a class that extends one of the tool items, and override any required methods.+===== Creating Tool Subclasses =====
  
-==== Registering Tools ====+**This section is not necessary in the current version of Fabric.** This is a good way to implement special attributes or behaviors for your tool, however.
  
-Registering tools is done the same way you would register a normal item.+In older versions, all base tool classes (''<yarn class_1810>'', ''<yarn class_1821>'', ''<yarn class_1794>'', ''<yarn class_1743>'', ''<yarn class_1829>'') require a ''<yarn class_1832>'', an attack speed (float), an additional attack damage amount (float for <yarn class_1743>; int for the rest), and an ''<yarn class_1792.class_1793>'' instance.
  
-<code java [enable_line_numbers=true]> +''<yarn class_1810>'' , ''<yarn class_1794>'' and ''<yarn class_1743>'' have protected constructors, which means you will need to create your own classes with public constructors:  
-    [...] +<yarncode java [enable_line_numbers=true]> 
-     +public class CustomPickaxeItem extends class_1810 { 
-    @Override +    public CustomPickaxeItem(class_1832 material, int attackDamage, float attackSpeed, class_1793 settings) { 
-    public void onInitialize() { +        super(material, attackDamage, attackSpeed, settings);
-        Registry.register(Registry.ITEM,new Identifier("tutorial","potato_pickaxe"), POTATO_PICKAXE); +
- Registry.register(Registry.ITEM,new Identifier("tutorial","potato_axe"), POTATO_AXE); +
- Registry.register(Registry.ITEM,new Identifier("tutorial","potato_sword"), POTATO_SWORD); +
- Registry.register(Registry.ITEM,new Identifier("tutorial","potato_hoe"), POTATO_HOE); +
-        Registry.register(Registry.ITEM,new Identifier("tutorial","potato_shovel"), POTATO_SHOVEL);+
     }     }
-</code>+} 
 +</yarncode> 
 + 
 +Using the public classes: 
 +<yarncode java> 
 +    public static class_1831 POTATO_PICKAXE = new CustomPickaxeItem(PotatoToolMaterial.INSTANCE, 1, -2.8F, new class_1792.class_1793()); 
 +    public static class_1831 POTATO_AXE = new CustomAxeItem(PotatoToolMaterial.INSTANCE, 7.0F, -3.2F, new class_1792.class_1793()); 
 +    public static class_1831 POTATO_HOE = new CustomHoeItem(PotatoToolMaterial.INSTANCE, 7, -3.2F, new class_1792.class_1793()); 
 +</yarncode>
  
-==== Making your tool work with non-vanilla blocks ====+===== Making your tool work with non-vanilla blocks =====
  
-Visit the last section of https://fabricmc.net/wiki/tutorial:mining_levels+See [[mining_levels]].
tutorial/tools.1596107039.txt.gz · Last modified: 2020/07/30 11:03 by boogiemonster1o1