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 [2022/12/16 00:32] – [Creating Tools] no item groups now solidblocktutorial: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]].
  
-==== Creating a Tool Material ====+===== Creating a Tool Material =====
  
 Tools require a ''<yarn class_1832>'', which defines the following behavior: Tools require a ''<yarn class_1832>'', which defines the following behavior:
Line 17: Line 18:
 <yarncode java [enable_line_numbers=true]> <yarncode java [enable_line_numbers=true]>
 public class PotatoToolMaterial implements class_1832 { public class PotatoToolMaterial implements class_1832 {
-     
     [...]     [...]
 } }
Line 27: Line 27:
 ''<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. ''<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]> <yarncode java [enable_line_numbers=true]>
-@Override +    @Override 
-public int method_8025() { +    public int method_8025() { 
-    return 500; +        return 500; 
-}+    }
 </yarncode> </yarncode>
  
Line 36: Line 36:
 ''<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. ''<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]> <yarncode java [enable_line_numbers=true]>
-@Override +    @Override 
-public float method_8027() { +    public float method_8027() { 
-    return 5.0F; +        return 5.0F; 
-}+    }
 </yarncode> </yarncode>
  
Line 45: Line 45:
 ''<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.  ''<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]> <yarncode java [enable_line_numbers=true]>
-@Override +    @Override 
-public float method_8028() { +    public float method_8028() { 
-    return 3.0F; +        return 3.0F; 
-}+    }
 </yarncode> </yarncode>
  
Line 54: Line 54:
 ''<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. ''<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]> <yarncode java [enable_line_numbers=true]>
-@Override +    @Override 
-public int method_8024() { +    public int method_8024() { 
-    return 2; +        return 2; 
-}+    }
 </yarncode> </yarncode>
  
Line 63: Line 63:
 ''<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. ''<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]> <yarncode java [enable_line_numbers=true]>
-@Override +    @Override 
-public int method_8026() { +    public int method_8026() { 
-    return 15; +        return 15; 
-}+    }
 </yarncode> </yarncode>
  
Line 72: Line 72:
 ''<yarn method_8023>'' returns the ''<yarn class_1856>'' required to repair a tool in an anvil. ''<yarn method_8023>'' returns the ''<yarn class_1856>'' required to repair a tool in an anvil.
 <yarncode java [enable_line_numbers=true]> <yarncode java [enable_line_numbers=true]>
-@Override +    @Override 
-public class_1856 method_8023() { +    public class_1856 method_8023() { 
-    return class_1856.method_8091(class_1802.field_8567); +        return class_1856.method_8091(class_1802.field_8567); 
-}+    }
 </yarncode> </yarncode>
  
-''<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 Tool Material class:+''<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:
 <yarncode java [enable_line_numbers=true]> <yarncode java [enable_line_numbers=true]>
 public class PotatoToolMaterial implements class_1832 { public class PotatoToolMaterial implements class_1832 {
- 
     public static final PotatoToolMaterial INSTANCE = new PotatoToolMaterial();     public static final PotatoToolMaterial INSTANCE = new PotatoToolMaterial();
          
Line 88: Line 87:
 </yarncode> </yarncode>
  
-''PotatoToolMaterial'' can now be referenced with ''PotatoToolMaterial.INSTANCE''.+''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 Tools ====+===== Creating Tools Items =====
  
-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.+**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).
  
-<yarncode java [enable_line_numbers=true]> +<yarncode java> 
-public static class_1831 POTATO_SHOVEL = new class_1821(PotatoToolMaterial.INSTANCE, 1.5F, -3.0F, new class_1792.class_1793()); +public final class TutorialItems { 
-public static class_1831 POTATO_SWORD = new class_1829(PotatoToolMaterial.INSTANCE, 3, -2.4F, new class_1792.class_1793());+    public static class_1831 POTATO_PICKAXE = new PickaxeItem(PotatoToolMaterial.INSTANCE, 1, -2.8F, new FabricItemSettings()); 
 +    public static class_1831 POTATO_AXE = new AxeItem(PotatoToolMaterial.INSTANCE, 7.0F, -3.2F, new FabricItemSettings()); 
 +    public static class_1831 POTATO_HOE = new HoeItem(PotatoToolMaterial.INSTANCE, 7, -3.2F, new FabricItemSettings()); 
 +}
 </yarncode> </yarncode>
 +
 +===== Creating Tool Subclasses =====
 +
 +**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.
 +
 +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.
  
 ''<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:  ''<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: 
Line 110: Line 118:
 Using the public classes: Using the public classes:
 <yarncode java> <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_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_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());+    public static class_1831 POTATO_HOE = new CustomHoeItem(PotatoToolMaterial.INSTANCE, 7, -3.2F, new class_1792.class_1793());
 </yarncode> </yarncode>
  
-If you want to add any special attributes or behaviors to your tool, create a subclass that extends one of the base tool classes, and override any required methods. +===== Making your tool work with non-vanilla blocks =====
- +
-==== Registering Tools ==== +
- +
-For a recap on registering items, read through the item tutorial [[tutorial:items|here]]. +
- +
-==== 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.1671150771.txt.gz · Last modified: 2022/12/16 00:32 by solidblock